About GitHub README Generator
Fill in a short form and get a ready-made GitHub profile README. Add your name, a line about yourself, what you are working on, links, the technologies you use and your projects, and the Markdown appears beside the form as you type. Copy it or download it as README.md. Everything is made in your browser and nothing is uploaded.
How to use GitHub README Generator
- Press Sample to see an example, or fill in the form. You can leave any field empty.
- Read the Markdown on the right. Empty fields are left out.
- Press Copy Markdown or Download README.md.
- On GitHub, create a public repository named exactly like your user name and add the text as README.md. It then shows on your profile.
Tips and good to know
- Your GitHub user name is needed for the GitHub badge and the stats card.
- You can type links with or without https://. Only web addresses are accepted, and anything else is left out with a message.
- Badges and the stats card are pictures loaded from other websites when people view your profile. Untick the options if you want plain text.
- Special Markdown characters in your text, like asterisks or square brackets, are escaped so they show as typed.
- Keep it short. A few lines about you and your best projects read better than a long list.
Frequently asked questions
Is the information I type uploaded?
No. The Markdown is built in your browser. Nothing is sent anywhere.
Where does the README go?
Create a public repository with the same name as your GitHub user name, add a README.md, and GitHub shows it at the top of your profile.
Why do the badges not show in the preview?
This tool shows the Markdown text only. Badges are loaded by GitHub when your profile is viewed.
Is the stats card safe to add?
It is a picture from a third-party service that reads your public GitHub data. It is off by default, and you decide whether to include it.
Can I edit the result?
Yes. It is plain Markdown, so you can change anything in your own editor or on GitHub.
Is GitHub README Generator free?
Yes. GitHub README Generator is free: no sign-up, no paid plan, no trial and no limit on how often you use it. It runs in your browser, and ToolzAura is paid for by ads, so every tool stays free.
Are my files uploaded?
No. This tool runs in your browser, so your input stays on your device.