README

[EdouardMailhot]

Addressing a Problem?

Ça pourrait être bien d'écrire dans le README sur la page d'accueil du repo (https://github.com/hydrologie/xhydro/blob/main/README.rst). Pas besoin d'être très complet, il servirait simplement à accueillir les nouveaux contributeurs en décrivant les différentes sections du repo. On pourrait également y mettre un lien vers un document qui explique le projet dans le détail.

Potential Solution

No response

Additional context

No response

Contribution

• I would be willing/able to open a Pull Request to contribute this feature.

[sebastienlanglois]

Tout à fait d'accord. Actuellement, le lien vers la documentation du projet est le suivant : hydrologie.github.io/xhydro/. À termes, suite au passage vers ReadTheDocs (#22), nous aurons un nouveau lien de projet. La documentation, actuellement presqu'inexistante, se génère à partir des fichiers .rst qui sont ici : https://github.com/hydrologie/xhydro/tree/main/docs . Il faudrait mettre le texte d'accueil dans le fichier index.rst ou encore, dans le reamdme.rst et ensuite faire référence au readme.rst dans le fichier index.rst.

On pourrait établir à la prochaine réunion qui serait intéressé à faire cela!