GitHub README Generator
Enter your project name, install steps, and license to generate, copy, and download a GitHub README.md
도구를 불러오는 중…
🔒 Everything runs 100% in your browser. Your files and input are never uploaded to any server.
Enter your project name, description, features, install commands, license, and more, and it produces a complete README.md — table of contents, badges, and code blocks included. Add your GitHub repo URL and star/issue badges link up automatically, and you can copy the result or download it straight as a README.md file.
How to use
- Enter your project name, one-line summary, and detailed description.
- Fill in key features, tech stack, install commands, and usage example code.
- Choose the license and whether to include badges, a table of contents, and contribution guidelines.
- Save with 'Copy Markdown' or 'Download README.md' and place it at the root of your repository.
FAQ
- How are the badges (shields.io) shown?
- The license and 'PRs welcome' badges are always inserted, while star and issue badges link to real values only when you enter a GitHub repo URL. If you don't need badges, uncheck 'Include badges'.
- Will the generated README render correctly on GitHub?
- Yes. It's written in standard Markdown syntax, so placing it as README.md at your repo root lets GitHub automatically render the headings, code blocks, table-of-contents links, and more.
- Is the project info I enter sent to a server?
- No. Markdown generation happens entirely inside your browser, and none of what you enter — project name, description, etc. — is ever sent to or stored on a server.