pub_soft/openfe
3
0
Fork 0
mirror of https://github.com/OpenFreeEnergy/openfe.git synced 2026-06-04 14:14:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update badge on front page

Browse Source 
This badge should point to stable/released docs, so people are linked to what documents the thing that they are most likely to be using.  Most people will be using conda builds, not dev/source builds, if they're using dev builds they'll also know how to get to the dev docs.

Removed disclaimer on pre-alpha status, we're 1.0rc
This commit is contained in:
richard gowers
2024-03-05 14:36:49 +00:00
committed by Richard Gowers
parent 1be52dfeb6
commit b032443dee
1 changed files with 4 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -1,7 +1,7 @@
[![Logo](https://img.shields.io/badge/OSMF-OpenFreeEnergy-%23002f4a)](https://openfree.energy/)
[![build](https://github.com/OpenFreeEnergy/openfe/actions/workflows/ci.yaml/badge.svg?event=schedule)](https://github.com/OpenFreeEnergy/openfe/actions/workflows/ci.yaml)
[![coverage](https://codecov.io/gh/OpenFreeEnergy/openfe/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenFreeEnergy/openfe)
[![documentation](https://readthedocs.org/projects/openfe/badge/?version=latest)](https://openfe.readthedocs.io/en/latest/?badge=latest)
[![documentation](https://readthedocs.org/projects/openfe/badge/?version=stable)](https://docs.openfree.energy/en/stable/?badge=stable)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8344248.svg)](https://doi.org/10.5281/zenodo.8344248)
@@ -12,17 +12,14 @@ a pre competitive consortium aiming to provide robust, permissively licensed ope
Using `openfe` you can easily plan and execute alchemical free energy calculations.
See our [website](https://openfree.energy/) for more information,
or [try for yourself](https://try.openfree.energy) from the comfort of your browser.
See our [website](https://openfree.energy/) for more information on the project,
[try for yourself](https://try.openfree.energy) from the comfort of your browser,
and we have [documentation on using the package](https://docs.openfree.energy/en/latest/index.html).
## License
This library is made available under the [MIT](https://opensource.org/licenses/MIT) open source license.
## Important note
This is pre-alpha work, it should not be considered ready for production and API changes are expected at any time without prior warning.
## Install
### Latest release