README generator

Fill in your project's essential information: the tool generates a structured README.md file (title, description, installation, usage, license), ready to copy or download.

Example:

How it works

Fill in the project name (the only required field), a description, the install command, a usage example and the license. The tool assembles this information into a structured Markdown document with a title, a table of contents, "Installation" and "Usage" sections with code blocks, and a "License" section. The result follows a structure close to the one recommended by most GitHub contribution guides.

Can I edit the README after it's generated?

Yes, the generated text is an editable starting point like any Markdown: after copying or downloading the file, add sections (Contributing, Tests, Screenshots) directly in your usual editor.

Does the license badge work for any license?

The badge is generated through the shields.io service using the license name exactly as entered; it displays correctly for common licenses (MIT, Apache-2.0, GPL-3.0...). For a custom license, the badge still works but looks less standardized.

All the information you enter stays in your browser: nothing is sent to a server to generate this README.