Skip to content

Commit

Permalink
README: add link to ReadTheDocs site
Browse files Browse the repository at this point in the history
Problem: The top-level README does not provide a link to
flux-accounting's ReadTheDocs pages.

Add a link. Add a ReadTheDocs badge for the build status of
flux-accounting's documentation.
  • Loading branch information
cmoussa1 committed Oct 15, 2024
1 parent de19bdc commit 3fed2fc
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[![ci](https://github.com/flux-framework/flux-accounting/workflows/ci/badge.svg)](https://github.com/flux-framework/flux-accounting/actions?query=workflow%3A.github%2Fworkflows%2Fmain.yml)
[![codecov](https://codecov.io/gh/flux-framework/flux-accounting/branch/master/graph/badge.svg)](https://codecov.io/gh/flux-framework/flux-accounting)
![docs](https://readthedocs.org/projects/flux-accounting/badge/?version=latest)

_NOTE: The interfaces of flux-accounting are being actively developed and are
not yet stable. The Github issue tracker is the primary way to communicate with
Expand Down Expand Up @@ -54,6 +55,12 @@ mounting /Users/moussa1/src/flux-framework/flux-accounting as /usr/src
[moussa1@docker-desktop src]$
```

### Documentation

To see detailed documentation about installing, administering, and configuring
flux-accounting, please see our official
[documentation pages](https://flux-accounting.readthedocs.io/en/latest/index.html).

#### Release

SPDX-License-Identifier: LGPL-3.0
Expand Down

0 comments on commit 3fed2fc

Please sign in to comment.