Gerador de README para GitHub: crie seu README.md

Informe nome do projeto, passos de instalação e licença para gerar, copiar e baixar um README.md do GitHub — grátis e direto no navegador.

Informe o nome do projeto, a descrição, os recursos, os comandos de instalação, a licença e muito mais, e a ferramenta monta um README.md completo — com sumário, badges e blocos de código. Se você adicionar a URL do seu repositório no GitHub, os badges de estrelas e de issues passam a apontar para os valores reais automaticamente, e você pode copiar o resultado ou baixá-lo direto como um arquivo README.md.

Carregando a ferramenta…

Tudo roda 100% no seu navegador. Seus arquivos e o que você digita nunca são enviados para um servidor.

Como usar

  1. Informe o nome do projeto, um resumo em uma linha e a descrição detalhada.
  2. Preencha os principais recursos, a stack de tecnologia, os comandos de instalação e um exemplo de código de uso.
  3. Escolha a licença e defina se quer incluir badges, sumário e diretrizes de contribuição.
  4. Salve com "Copiar Markdown" ou "Baixar README.md" e coloque o arquivo na raiz do seu repositório.

Perguntas frequentes

Como os badges (shields.io) aparecem?
Os badges de licença e de "PRs welcome" são sempre inseridos, enquanto os badges de estrelas e de issues apontam para valores reais apenas quando você informa a URL de um repositório no GitHub. Se você não quiser badges, basta desmarcar "Incluir badges".
O README gerado vai ser exibido corretamente no GitHub?
Sim. Ele é escrito em sintaxe Markdown padrão, então, ao colocar o arquivo como README.md na raiz do seu repositório, o GitHub renderiza automaticamente os títulos, os blocos de código, os links do sumário e muito mais.
As informações do projeto que eu preencho são enviadas para algum servidor?
Não. A geração do Markdown acontece totalmente dentro do seu navegador, e nada do que você digita — nome do projeto, descrição etc. — é enviado ou armazenado em um servidor.

Ver todas as ferramentas