ETQ Utilisateur/Dev je veux un README informatif
ETQ Utilisateur/Dev je veux un README informatif
Mettre à jour le README en s'inspirant de celui de {conjdown} :
https://git.lab.sspcloud.fr/propre-conj/conjdown
Validation
-
Je valide que le README est visible sur le dépôt git: https://git.lab.sspcloud.fr/propre-conj/conj.region -
Je valide que le README est visible sur le site du package: https://propre-conj.pages.lab.sspcloud.fr/conj.region/index.html -
Je valide que le README comporte bien : -
Des badges montrant le status du CI et du code coverage -
Une courte présentation des fonctionalités clefs du package (Présentation) -
Comment installer le package depuis le AUS (Installation) -
Des instructions d'installation alternatives présente dans dev/si_problemes_installation.Rmd -
Un court paragraphe sur comment utiliser le package (Utilisation)
-
Comment Technique
-
Adapter le README de {conjdown}:
https://git.lab.sspcloud.fr/propre-conj/conjdown
- [ ] S'assurer que la balise -> Instructions spéciales en cas d'échec de l'install déportées dans dev/si_problemes_installation.Rmddetails
fonctionne correctement
-
Inclure les instructions d'installation depuis AUS cf #32 (closed)
Edited by Marc Henninger