Gerador de README
Preencha as informações essenciais do seu projeto: a ferramenta gera um arquivo README.md estruturado (título, descrição, instalação, uso, licença), pronto para copiar ou baixar.
Como funciona
Preencha o nome do projeto (único campo obrigatório), uma descrição, o comando de instalação, um exemplo de uso e a licença. A ferramenta reúne essas informações em um documento Markdown estruturado, com título, índice, seções "Instalação" e "Uso" com blocos de código e uma seção "Licença". O resultado segue uma estrutura próxima à recomendada pela maioria dos guias de contribuição do GitHub.
Posso editar o README depois de gerado?
Sim, o texto gerado é um ponto de partida editável como qualquer Markdown: depois de copiar ou baixar o arquivo, adicione seções (Como contribuir, Testes, Capturas de tela) diretamente no seu editor de costume.
O selo de licença funciona para qualquer licença?
O selo é gerado pelo serviço shields.io com o nome da licença digitado exatamente como está; ele é exibido corretamente para as licenças mais comuns (MIT, Apache-2.0, GPL-3.0...). Para uma licença personalizada, o selo continua funcionando, mas é visualmente menos padronizado.
Todas as informações digitadas permanecem no seu navegador: nada é enviado a um servidor para gerar este README.