Bonjour bonsoir !

Je suis actuellement en stage et je travaille malgré tout (on dirait pas comme ça ).

J'ai récemment fini de développer mon appli (Perl, R et du bash pour le fond si ça vous intéresse) et je vais le mettre en forme par la suite, mais ça c'est pour plus tard - DEVELOPPEUR HTML TMTC

Bref ! Sur le site que je suis en train de créer, il y aura possibilité pour les bio-informaticiens de DL mes codes afin de les utiliser de façon noble (comprendre : dans un shell), un zip avec les fichiers que j'ai utilisé de base + les scripts + un read-me

Du coup je me demande ce que vous mettriez dans un read-me ?

En gros, ce que je développe consiste en 3 étapes :
- création d'un fichier contenant de façon "brute" des noms d'espèces (animales ou végétales) et un autre fichier contenant des appellations de gènes
- traitement de ces fichiers afin de récupérer des séquences d'ADN, de les nettoyer, les mettre en forme, je vous épargne les détails biologiques
- traitement de ces séquences d'ADN par des outils statistiques afin d'en sortir des arbres de phylogénie (genre les arbres d'évolution quoi)

Et j'avoue être totalement perdue, je sais pas quoi mettre dedans

afin de les utiliser de façon noble (comprendre : dans un shell)

même pas tu fais une interface graphique. tu mérites de te faire lapider.

"read me" trollesque:
cf les commentaires dans le code source

"read me" propre:
explication des différentes fonctions du programme.
j'imagine qu'il y a des fonctions.
tu fais le listing.
pas forcément exhaustif, mais si ça marche avec le shell, explique au moins quelles sont les fonctions principales, et comment on utilise les arguments.

Fais une FIC pron avec Fleke dedans
Ils vont insta-chopper une érection

"Personne ne lit jamais les README, alors pour avoir de l'aide tapez --help après le nom du binaire, lol"

ou alors encore mieux.

tu fais un readmeception et tu mets dans le readme:

"RTFM."

et la le lecteur en

Contenu du Readme:

Astuces:
1 - Le readme peut s'avérer très utile et vous aidez à utiliser le programme.
2- La première astuce est très importante.

MDR G PA LU OLOLOLO