README

Un fichier README est un document texte, généralement au format Markdown ou en texte brut, qui accompagne un projet informatique, un logiciel, un projet open source, ou même un répertoire de fichiers. Son objectif principal est de fournir des informations essentielles sur le projet, afin d'aider les utilisateurs, les développeurs et les collaborateurs à comprendre comment utiliser, installer, configurer ou contribuer au projet.

On trouve généralement dans un fichier README :

Description du projet : Une brève présentation du projet, de son objectif et de son utilité.

Instructions d'installation : Des étapes détaillées pour installer le logiciel ou le projet sur votre système.

Configuration : Des informations sur les configurations nécessaires, telles que les dépendances, les paramètres de configuration, les fichiers requis, etc.

Utilisation : Des instructions sur la manière d'utiliser le projet, incluant des exemples d'utilisation, des commandes en ligne, des captures d'écran, etc.

Problèmes connus : Une liste des problèmes connus ou des bogues, le cas échéant, avec des solutions temporaires ou des pistes pour les résoudre.

Contributions : Des informations sur la manière de contribuer au projet, les directives de développement, les normes de codage, les processus de demande de fusion (pull request), etc.

Auteurs : La liste des personnes ou des organisations ayant contribué au projet, avec éventuellement des liens vers leurs profils en ligne.

…

Bonnes pratiques

• Placer un fichier README.md à la racine du code source ou du projet.
• Suivre les recommandations : Make a README.
• Utiliser le langage de balisage léger Markdown pour la rédaction des fichiers README.

Note

Dans la plupart des plateformes de gestion de code (comme GitHub, GitLab ou Bitbucket), le fichier README est affiché par défaut lorsque l'on accède au projet.

Exemples

• PHPMailer
• Electron
• Java JWT

---

Foobar

Foobar is a Python library for dealing with word pluralization.

Installation

Use the package manager pip to install foobar.

pip install foobar

Usage

import foobar

# returns 'words'
foobar.pluralize('word')

# returns 'geese'
foobar.pluralize('goose')

# returns 'phenomenon'
foobar.singularize('phenomena')

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

…