Developer Mise à jour de l'outil il y a 2 mois

GitHub README Generator

Generate a professional GitHub README.md with badges, sections, installation instructions, usage examples, and license information.

Toujours gratuit Facile à utiliser Des résultats immédiats Confidentiel et sécurisé

Utilisation GitHub README Generator

GitHub README Generator

Generate a clean README.md with badges, features, install steps, usage, contributing, and license sections.

Project Details

Basic repository information
Owner and repo are used for badges.
Not generated yet
README status
0 sections
Generated sections

README.md

Generated Markdown output

README Content

Features, installation, usage, and badges
One feature per line. Leading dashes are optional.
Build and stars badges require GitHub owner and repo name.
README tip
Add owner and repo to enable badge URLs. Generate first, then copy or download the README.md file.
Lien vers l'outil
Copié dans le presse-papiers.
Aidez-nous à améliorer cet outil

Lire le contenu

Découvrez comment fonctionne cet outil et dans quelles circonstances l'utiliser.

The GitHub README Generator helps you create polished, well-structured README.md files for your GitHub repositories. A great README makes your project easier to understand, install, and contribute to.

Why Use This Tool?

A well-written README is essential for any GitHub project. This generator builds a complete template with Features, Install, Usage, Contributing, and License sections, plus optional shields.io badges — all from a simple form.

How It Works

  • Enter the project name, description, license, and GitHub owner/repo (used to build badge URLs).
  • List your features (one per line) and add Install and Usage text, optionally marked as code blocks with a custom language.
  • Toggle the badges you want: License, Build status, and Stars.
  • Click Generate to preview the Markdown output.
  • Copy the README to your clipboard or download it as a .md file.

Key Features

  • Complete template with Features, Install, Usage, Contributing, and License sections
  • shields.io badges for License, Build, and Stars
  • Optional code-block formatting for Install and Usage with custom language
  • Live character, line, and section counters
  • Copy to clipboard and download as .md
  • Free online tool, no signup

Commentaires (0)

Pour les discussions entre utilisateurs, les cas particuliers et les conseils complémentaires.
Laisser un commentaire
Votre commentaire sera visible par tous après sa publication.
Aucun commentaire pour l'instant. Soyez le premier à laisser un commentaire !
Faites-le-nous savoir !
Signaler un problème avec cet outil

Décrivez le problème que vous avez rencontré afin que nous puissions l'examiner et améliorer l'outil.

Ce qui aide le plus
Veuillez indiquer la saisie effectuée, le résultat attendu, le résultat obtenu, le navigateur ou l'appareil utilisé, ainsi qu'une capture d'écran si cela peut être utile.
Le bouton « Capture d'écran » permet de capturer la page affichée dans le navigateur et d'ajouter l'image générée à ce formulaire.
Capture d'écran en pleine page
Capturé dans votre navigateur avec newisty.
Aucune capture d'écran n'a encore été réalisée.
Outil Rapport