Skip to content

Instantly share code, notes, and snippets.

@JulienRAVIA
Forked from outout14/README-Template.md
Created May 19, 2017 18:49
Show Gist options
  • Save JulienRAVIA/1cc6589cbf880d380a5bb574baa38811 to your computer and use it in GitHub Desktop.
Save JulienRAVIA/1cc6589cbf880d380a5bb574baa38811 to your computer and use it in GitHub Desktop.
Une template pour faire un joli README.md

Titre du projet

(juste en dessous des badges sympatiques à placer)

forthebadge forthebadge

Une petite description du projet

Pour commencer

Entrez ici les instructions pour bien débuter avec votre projet...

Pré-requis

Ce qu'il est requis pour commencer avec votre projet...

  • Programme 1
  • Programme 2
  • etc...

Installation

Les étapes pour installer votre programme....

Dites ce qu'il faut faire...

exemple: Executez la commande telnet mapscii.me pour commencer ensuite [...]

Ensuite vous pouvez montrer ce que vous obtenez au final...

Démarrage

Dites comment faire pour lancer votre projet

Fabriqué avec

Entrez les programmes/logiciels/ressources que vous avez utilisé pour développer votre projet

exemples :

Contributing

Si vous souhaitez contribuer, lisez le fichier CONTRIBUTING.md pour savoir comment le faire.

Versions

Listez les versions ici exemple : Dernière version stable : 5.0 Dernière version : 5.1 Liste des versions : Cliquer pour afficher (pour le lien mettez simplement l'URL de votre projets suivi de /tags)

Auteurs

Listez le(s) auteur(s) du projet ici !

Lisez la liste des contributeurs pour voir qui à aidé au projet !

(pour le lien mettez simplement l'URL de votre projet suivi de /contirubors)

License

Ce projet est sous licence exemple: WTFTPL - voir le fichier LICENSE.md pour plus d'informations

@BERTHETquentin
Copy link

Merci beaucoup

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment