Link to documentation in README

luigibonati / mlcolvar

A unified framework for machine learning collective variables for enhanced sampling simulations

MIT License

91 stars 24 forks source link

Link to documentation in README #141

Closed recisic closed 2 months ago

recisic commented 2 months ago

Ciao mlcolvar team,

Thanks for the useful package! I wanted to let you know that there is no link to the documentation in the README.md except for the docs status badge, so it's hard to find the documentation.

How about adding links to:

The "documentation" and "examples" in the following part of the README
About section on the right of the GitHub page

https://github.com/luigibonati/mlcolvar/blob/3f9adeb6d02e60161f44f06b413adcec76c216cd/README.md?plain=1#L34

Grazie mille, Juno

luigibonati commented 2 months ago

Hi Juno! Thanks for the suggestion, I've added more explicit links to the doc

Ciao, Luigi