Auteur

👤Thierry LAVAL 🇫🇷 Contactez moi 🇬🇧

• Github: @Thierry Laval
• LinkedIn: @Thierry Laval

---

📎 Projet 22 - Création d'un fichier README pour GitHub

Début du projet le 10/09/2021

Un bon template README

Un modèle de fichier génial pour lancer vos projets !
>> Explorer les documents <<

Voir la démo · Rapport de Bug · Demande de fonctionnalité

---

Table des matières

1. A propos du projet
   • Construit avec
2. Commencer à travailler
   • Conditions préalables
   • Installation
3. Utilisation
4. Feuille de route
5. Contribution
6. License
7. Contact
8. Remerciements

A propos du projet

Il existe de nombreux modèles de README sur GitHub, mais je n'en ai pas trouvé un qui réponde vraiment à mes besoins, alors j'ai créé ce modèle amélioré.

Bien sûr, il n'existe pas de modèle unique pour tous les projets, car vos besoins peuvent être différents. Vous pouvez suggérer des changements en créant une demande de modification ou en ouvrant un problème. Merci à toutes les personnes qui ont contribué à l'expansion de ce modèle !

Une liste de ressources couramment utilisées et que je trouve utiles est listée dans les remerciements.

Construit avec

Cette section doit énumérer tous les principaux frameworks que vous avez utilisés pour construire votre projet. Laissez les add-ons/plugins pour la section remerciements.
Voici quelques exemples.

• Bootstrap
• JQuery
• Laravel

Commencer à travailler

Il s'agit d'un exemple de la façon dont vous pouvez donner des instructions sur la mise en place de votre projet localement. Pour mettre en place une copie locale et la faire fonctionner, suivez les étapes simples de cet exemple.

Conditions préalables

Voici un exemple de la liste des éléments dont vous avez besoin pour utiliser le logiciel et de la façon de les installer.

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com

2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

Utilisation

Utilisez cet espace pour montrer des exemples utiles de la façon dont un projet peut être utilisé. Des captures d'écran supplémentaires, des exemples de code et des démos fonctionnent bien dans cet espace. Vous pouvez également créer un lien vers d'autres ressources.

Pour plus d'exemples, veuillez vous référer à la [Documentation] (https://example.com).

Feuille de route

Voir le open issues pour une liste des fonctionnalités proposées (et des problèmes connus).

Contribuer

Les contributions sont ce qui fait de la communauté open source un endroit si incroyable pour apprendre, inspirer et créer. Toutes les contributions que vous faites sont grandement appréciées.

1. Forkez le projet
2. Créez votre branche Feature (git checkout -b feature/AmazingFeature)
3. Commitez vos changements (git commit -m 'Add some AmazingFeature')
4. Pusher vers la branche (git push origin feature/AmazingFeature)
5. Ouvrez une Pull Request

Licence

Distribué sous la licence MIT. Voir LICENSE pour plus d'informations.

Contact

Thierry Laval - @twitter - contact@thierrylaval.dev

Project Link: https://github.com/thierry-laval/P22-template-pour-un-readme

Remerciements

• GitHub Emoji Cheat Sheet
• Img Shields
• Choose an Open Source License
• GitHub Pages
• Animate.css
• Loaders.css
• Slick Carousel
• Smooth Scroll
• Sticky Kit
• JVectorMap
• Font Awesome

---

Utilisé dans ce projet

Langages	et Applications
Firefox développeur	Visual Studio Code
Git/GitHub	Markdown

N'hésitez pas à contribuer, en ouvrant une issue.

Merci à tous

---

♥    Love Markdown

FAN DE GITHUB !