Softonic

Générateur de README

Étape 1 / 4 README.md
Suivant

Les dépôts vides laissent une mauvaise première impression. Renseignez le nom du projet, un slogan d’une ligne, une liste de fonctionnalités, la commande d’installation, un extrait de démarrage rapide, l’auteur et la licence, et ce générateur produit un README Markdown propre avec une hiérarchie de titres correcte et des blocs de code délimités : les sections que GitHub affiche sur la page d’accueil de votre projet. Copiez-le, enregistrez-le sous README.md à la racine de votre dépôt, puis poussez. Les titres de sections sont rédigés en anglais, la convention quasi universelle des README open source ; votre propre texte apparaît exactement tel que vous le saisissez, dans n’importe quelle langue.

Comment rédiger un README

  1. 1

    Ajoutez l'essentiel

    Nom du projet, une URL de dépôt facultative et un slogan d'une ligne. Le nom devient le titre `#` ; le slogan devient la citation en dessous.

  2. 2

    Listez les fonctionnalités et un démarrage rapide

    Une fonctionnalité par ligne (chacune devient une puce), plus un court extrait de démarrage rapide enveloppé dans un bloc de code délimité.

  3. 3

    Installation, licence et auteur

    La commande d'installation va dans un bloc de code `bash` sous Installation ; ajoutez la licence (MIT, Apache-2.0…) et une ligne d'auteur facultative.

  4. 4

    Copiez le Markdown

    Cliquez sur copier et collez la sortie en tant que `README.md` à la racine de votre dépôt. Poussez et la version rendue apparaît sur la page du projet.

Ce qu’un bon README contient

Le guide de style de GitHub et la spécification standard-readme largement utilisée s’accordent sur l’ordre. Mettez les éléments faciles à parcourir en haut, une personne qui arrive sur votre dépôt décide en 20 secondes si elle continue à lire.

Section Position Objectif
Titre + slogan Ligne 1–2 # Projet suivi d’une phrase sur ce qu’il fait
Badges Ligne 3–5 État CI, version npm, licence, couverture
Installation Sans défiler Une seule commande que quelqu’un peut copier
Utilisation Sans défiler L’extrait minimal viable qui produit une sortie
API / options Milieu Tableaux d’options, de clés de configuration ou de points de terminaison
Contribution Près de la fin Lien vers CONTRIBUTING.md, code de conduite, conventions de PR
Licence Dernière Identifiant SPDX plus lien vers LICENSE

Badges qui aident vraiment

Les URL de Shields.io suivent un modèle prévisible : https://img.shields.io/badge/<label>-<message>-<color>.svg. Les badges utiles pointent vers l’état de construction, la version du package et les comptes de téléchargement, pas des métriques de vanité. Quatre badges suffisent généralement ; plus c’est du bruit.

Erreurs courantes dans les README

  • Pas de commande d’installation à la ligne 1 de l’Installation. Les lecteurs cherchent npm install ou pip install ; si vous le cachez derrière du texte, ils partent.
  • Captures d’écran de 3 Mo. Redimensionnez à 800 px de large et compressez, GitHub les servira de toute façon, mais les lecteurs mobiles paient la bande passante.
  • Badges obsolètes. Un badge CI rouge indique aux visiteurs que le projet est cassé. Réparez CI ou retirez le badge.
  • Licence manquante. Sans licence, votre code est “tous droits réservés” par défaut et les entreprises ne peuvent pas l’utiliser.

Questions fréquentes

Oui. Les blocs de code délimités, les listes à puces et les titres de style ATX (préfixe #) s’affichent sur GitHub, GitLab et Bitbucket sans modifications. La commande d’installation est balisée comme un bloc bash ; le bloc de démarrage rapide est laissé sans balise pour que vous définissiez la langue vous-même.

Pour la plupart des écosystèmes, README.md. Utilisez .rst uniquement si vous publiez un package Python dont la documentation se trouve sur Read the Docs et que vous souhaitez que Sphinx réutilise le fichier comme page d’accueil.

Lorsque vous fournissez une URL de dépôt, le générateur ajoute un unique badge de licence statique (https://img.shields.io/badge/license-<type>-blue.svg). Pour des badges en direct (état de construction, version, téléchargements), copiez un modèle d’URL shields.io et collez-le vous-même dans la sortie.

Non. Le README est assemblé à partir des valeurs du formulaire et rien n’est enregistré. Fermez l’onglet et les données sont perdues.

Outils similaires

Référence de la table ASCII

Table ASCII complète de 0 à 127 avec décimal, hexadécimal, octal, binaire et référence numérique HTML pour chaque caractère, y compris les codes de contrôle comme NUL, LF et DEL.

Référence des caractères HTML

Liste consultable des entités HTML, de leurs codes nommés et numériques, et un copier-coller en un clic pour les caractères et symboles spéciaux.

Compteur de FPS

Mesurez les FPS du navigateur avec requestAnimationFrame : lissage, fréquence d'images min et max, seuil d'alerte et graphique facultatif. Tout se passe en local, sans envoi ni API.

Référence des raccourcis clavier

Recherchez les raccourcis par défaut documentés de VS Code, Chrome et Bash avec GNU Readline sous macOS, Windows et Linux.

Générateur de carte CSS

Créez le CSS d’un conteneur de carte : fond, bordure, rayon des angles, espacement intérieur et ombre douce, avec aperçu immédiat et code à copier-coller.

Recherche de nom de couleur

Trouvez la couleur nommée CSS standardisée la plus proche d’une valeur HEX, RGB ou HSL grâce à l’écart CIEDE2000.

Outil disponible dans d’autres langues