Gerador de README do GitHub
Crie um README.md profissional para o seu projeto no GitHub: badges, sobre, funcionalidades, stack, instalação, uso, variáveis de ambiente, roadmap, contribuição, licença e autor.
Carregando Gerador de README do GitHub…
Seus arquivos nunca saem do seu dispositivo
Como usar Gerador de README do GitHub
- 1
Abra Gerador de README do GitHub nesta página. Ele carrega direto no seu navegador.
- 2
Adicione seu arquivo, texto ou valores e ajuste as configurações.
- 3
Copie ou baixe o resultado. Nada é enviado nem armazenado.
Sobre esta ferramenta
O README é a vitrine de todo repositório: é a primeira coisa que visitantes, recrutadores e colaboradores leem. Este gerador de README do GitHub monta um README.md completo e bem estruturado a partir de um formulário curto. Preencha os dados do projeto, ligue ou desligue seções, escolha a sua stack e copie o Markdown ou baixe o arquivo. O rascunho fica salvo no navegador enquanto você trabalha.
Como criar um README
- Informe o nome do projeto, o slogan e a descrição.
- Adicione o repositório do GitHub (user/repo) para gerar badges, e uma URL de demonstração se tiver.
- Escolha as seções que quer incluir e as tecnologias da sua stack.
- Escolha uma licença: MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, MPL 2.0 ou Unlicense, e adicione o autor.
- Confira a prévia e copie o Markdown ou baixe o README.md.
Seções que você pode incluir
- Badges do shields.io: estrelas, licença e mais.
- Sobre e funcionalidades: o que o projeto faz e por quê.
- Stack: as linguagens e frameworks usados.
- Instalação e uso com blocos de código.
- Variáveis de ambiente necessárias para rodar.
- Roadmap, regras de contribuição, licença e autor.
O que faz um bom README
- Diga o que o projeto faz em uma frase logo no topo.
- Mostre: uma captura de tela ou GIF no topo explica mais que parágrafos.
- Deixe a instalação no copiar e colar: comandos exatos, em ordem, que funcionam em uma máquina limpa.
- Mantenha atualizado quando comandos ou opções mudarem.
Edite o resultado no editor de Markdown, adicione tabelas com o gerador de tabelas Markdown e consulte a sintaxe no guia rápido de Markdown.
Perguntas frequentes
O que um README deve ter?
O que o projeto faz, como instalar e usar, a stack, como contribuir e a licença. Badges e uma captura de tela ajudam os visitantes a entender rápido.
Onde coloco o arquivo README?
Na raiz do repositório, com o nome README.md. O GitHub exibe automaticamente na página do repositório.
Posso adicionar badges?
Sim. Informe o repositório como user/repo e o gerador adiciona os badges do shields.io.
Quais licenças posso escolher?
MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, MPL 2.0 e Unlicense. Adicione também o arquivo LICENSE completo ao repositório.
Meu rascunho fica salvo?
Sim, no armazenamento local do navegador, então continua lá quando você volta no mesmo dispositivo.
Posso criar um README de perfil?
Sim. Crie um repositório com exatamente o seu nome de usuário e use o README para se apresentar; o GitHub mostra no seu perfil.