What sections does it generate?

It produces a title with badges, a description, a table of contents, features, installation, usage, tech stack, contributing, and license sections. You can leave optional fields blank to omit a section.

Where do the badges come from?

Badges are generated as shields.io image URLs built from your repo path, so the license, last-commit, and stars badges render live from GitHub once the README is in your public repository.

Can I use this for a non-JavaScript project?

Yes. The install and run commands are free text, so you can put pip install, cargo build, go run, or any commands. The tech stack tags are just labels and work for any language or framework.

Does it support a table of contents?

Yes. A linked table of contents is generated using GitHub's heading-anchor convention, where spaces become hyphens and text is lowercased, so the links jump to the right sections.

Is my project data uploaded?

No. The README is assembled entirely in your browser from the fields you type. Nothing is sent to a server, so it is safe to use for private or unreleased projects.

What is the README.md Generator?

Turn a project name, description, tech stack, and key commands into a polished README.md with shields.io badges, a features list, installation steps, usage examples, a table of contents, and contributing and license sections — ready to paste into your repo. It runs free in your browser on Gera Tools, with nothing uploaded.

README.md Generator — Gera Tools

Name: README.md Generator
Creator: Gera Tools
License: https://creativecommons.org/licenses/by/4.0/

Get one useful tool a week

Like this tool? Enter your email and we'll send you one genuinely useful Gera tool a week — plus a link to come back to this one. No spam, one-click unsubscribe any time.

A good README is the front door of any repository. This generator turns a handful of fields — name, description, stack, and key commands — into a complete, well-structured README.md with badges, a table of contents, and the standard installation, usage, contributing, and license sections.

What gets generated

The output follows the structure that works well on GitHub and is familiar to most contributors:

Title and badges — the project name as an H1 heading, followed by shields.io badge image URLs built from your owner/repo. License, last-commit, and stars badges render live once the README is in a public repository.
Description — a one-paragraph summary from the field you filled in.
Table of contents — auto-generated by slugifying each section heading (lowercase, spaces to hyphens), matching GitHub’s automatic anchor IDs.
Features — a bullet list from your feature entries.
Installation — your install command in a fenced code block.
Usage — your usage command and any usage notes in a code block.
Tech stack — your stack entries rendered as inline text or as badge-style labels.
Contributing — standard guidance on fork-branch-PR workflow.
License — the license you specified.

Empty sections are omitted so the output does not look padded.

How the table of contents anchors work

GitHub converts every heading to an anchor by lowercasing the text and replacing spaces and most punctuation with hyphens. For example, ## Getting Started becomes #getting-started. The generator matches this algorithm, so all links in the table of contents resolve correctly. The one pitfall: if you paste the generated README and then edit a heading manually, update the TOC link to match.

Tips for a strong README

One sentence for the description. It appears in GitHub’s repository search results and social previews, so make it self-contained and specific. Compare “A tool that does stuff” with “CLI utility that converts Markdown to a well-structured PDF with custom fonts and page layouts.”
Show the fastest path to a working state. The install and usage sections should let a developer go from zero to running in under two minutes. If there are more steps (environment variables, database setup), list them in numbered order, not as a paragraph.
Link screenshots or demos. A README with a gif or screenshot of the UI or CLI output dramatically increases star rates and contributor confidence. Add the link after pasting the generated skeleton.
Use standard tech-stack tag names. TypeScript, Next.js, PostgreSQL are recognisable. Abbreviations like TS, Next, PG are less searchable and look informal.
Verify badge URLs. Shields.io badges pull live data, so the license badge only renders correctly if your repository has a LICENSE file that GitHub can detect. Misconfigured badges show broken-image icons.

The README is assembled entirely in your browser — nothing is sent anywhere, so it is safe to use this for private or unreleased projects.