Gerador de README.md
Preencha um formulário curto e receba um README.md limpo para o GitHub com badges, instalação, uso, recursos, contribuição e licença, mais uma prévia Markdown ao vivo.
dono/repo, usado nos badges e no comando git clone.
Um recurso por linha.
Os títulos das seções ficam em inglês, a convenção usual em READMEs de código aberto. Seu texto é mantido como você digitou.
Ferramentas Relacionadas
Ver TodasO que é Gerador de README?
O README é o primeiro arquivo que as pessoas leem em um repositório. Esta ferramenta transforma alguns campos — nome do projeto, descrição, recursos, comandos de instalação e uso, licença e autor — em um README.md bem estruturado, com badges opcionais do shields.io, sumário e guia de contribuição. Você pode alternar entre o código Markdown e a Pré-visualização renderizada.
Como usar Gerador de README
- Informe o Nome do projeto e, se estiver no GitHub, o Repositório no GitHub como
owner/repo. - Adicione um Slogan de uma linha, a Descrição, os Recursos (um por linha), o Comando de instalação e o Exemplo de uso.
- Escolha uma Licença, informe o Autor e ative ou desative os badges, o Sumário e a Seção de contribuição.
- Confira a Pré-visualização e copie ou baixe o README.md.
Exemplo
Project name tiny-cache, tagline "A 1 KB LRU cache", repository acme/tiny-cache, install npm install, license MIT, no badges/TOC/contributing
# tiny-cache > A 1 KB LRU cache ## Installation ```bash git clone https://github.com/acme/tiny-cache.git cd tiny-cache npm install ``` ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Quando usar Gerador de README
Use-o para começar em um minuto o README de uma biblioteca, CLI, projeto pessoal ou repositório interno e depois refinar o texto à mão. Ele gera um esqueleto sensato, não uma documentação: você ainda precisa explicar configuração, detalhes de API e exemplos específicos do seu projeto.
Como funciona Gerador de README
O formulário é montado em Markdown no estilo do GitHub: um H1 com o nome, badges opcionais (licença, estrelas e issues do img.shields.io, com link para o repositório), um slogan em citação e depois seções de Recursos, Instalação (com um bloco git clone + cd quando há repositório), Uso (um bloco de código na linguagem escolhida), Contribuição, Licença e Autor. Os links do sumário seguem as regras de âncoras de títulos do GitHub. A prévia é renderizada com marked e sanitizada com DOMPurify.
Casos de Uso Comuns
- Criar o README inicial de um novo pacote open source
- Padronizar a estrutura dos READMEs nos repositórios da equipe
- Adicionar rapidamente seções de licença e contribuição
- Criar um README para um projeto de portfólio ou hackathon
Perguntas Frequentes
Ele também cria o arquivo LICENSE?
Não. Ele acrescenta uma seção de Licença com link para LICENSE; adicione o texto da licença ao seu repositório (o GitHub pode criá-lo para você).
Por que os títulos estão em inglês?
Títulos de seção em inglês são a convenção em READMEs open source e facilitam a leitura por colaboradores do mundo todo. O seu próprio texto fica no idioma em que você o escrever.
Os badges funcionam em repositórios privados?
O Shields.io não consegue ler repositórios privados do GitHub, então os badges de estrelas e issues só mostram dados de repositórios públicos.