Archives par tags: Readme

Découverte :
Les mystérieuses cités d'or

La bioinformatique est un domaine de recherche donc, avec régulièrement de nouveaux logiciels et très souvent​​*​ votre premier contact avec ce nouveau logiciel se fait via la forge logiciel GitHub. Sur GitHub la première chose que l'utilisateur voit c'est le Readme (pour plus de détails sur ce fichier aller lire cet excellent billet de blog). Ce fichier qui résume l'objectif du projet/outil, comment le compiler/l'installer/l'utiliser (rayer les mentions inutiles), mais aussi quand c'est un outil de recherche, quelle publication citer quand on a utilisé l'outil...

Opinion :
Qu'est-ce qu'un bon fichier Lisez-moi.txt

Vous venez de finir votre outil sur lequel vous travaillez depuis 1 semaine/1 mois/1 an/10 ans (rayez la mention inutile) qui va révolutionner votre domaine.

Votre code est versionné, formaté, commenté, documenté, testé, les résultats sont évalués selon le gold standard de la discipline sur des jeux de données représentatifs de la réalité, votre publication est prête, vous allez l'envoyer sur le dépôt de preprint et au journal, le thread Twitter d'annonce est rédigé...