Skip to content

Instantly share code, notes, and snippets.

@outout14
Forked from PurpleBooth/README-Template.md
Last active October 23, 2021 09:33
Show Gist options
  • Save outout14/8aba8a5d9d700d836be50cec81692317 to your computer and use it in GitHub Desktop.
Save outout14/8aba8a5d9d700d836be50cec81692317 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

@lefuturiste
Copy link

Cool template!

@tisseurdetoile
Copy link

Merci beaucoup.

@bensuperpc
Copy link

Merci :)

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