Como usar: Gerador de README
- Escolha o tipo de projeto — biblioteca, app / site ou site Webflow — ou carregue um dos exemplos para ver um README pronto.
- Preencha o nome, o slogan e a descrição. Adicione o repositório do GitHub e o nome do pacote para gerar automaticamente os comandos de instalação e os badges.
- Adicione recursos, um exemplo de uso, opções de configuração, variáveis de ambiente e um roadmap. Seções vazias são simplesmente omitidas.
- Confira o preview ao vivo e o checklist de completude, depois clique em Copiar ou Baixar README.md e faça commit na raiz do seu repositório.
O que faz um bom README?
O README é a página inicial de um projeto. No GitHub, npm e PyPI, é a primeira — e muitas vezes a única — coisa que as pessoas leem antes de decidir usar, contratar ou contribuir. Os melhores READMEs respondem cinco perguntas nesta ordem: o que é, por que devo me importar, como instalo, como uso e sob qual licença. Todo o resto (configuração, roadmap, contribuição) serve de apoio a essas respostas.
A estrutura usada por este gerador
| Seção | Por que ela existe |
|---|---|
| Título + badges | Nome, versão, status do build e licença de relance (badges via shields.io). |
| Slogan | Uma frase que explica o projeto — também usada pelo GitHub e nos trechos de busca. |
| Captura de tela | Para apps e bibliotecas de UI, uma imagem é a explicação mais rápida. |
| Recursos | Tópicos fáceis de escanear que ajudam a decidir em segundos. |
| Instalação | Comandos exatos, prontos para copiar, para o seu gerenciador de pacotes, além das variáveis do .env. |
| Uso | O menor exemplo funcional possível. Esta é a parte mais lida de qualquer README. |
| Configuração | Opções em tabela com tipo, padrão e descrição. |
| Roadmap, Contribuição, Licença | O que vem a seguir, como ajudar e como o código pode ser usado. |
README para projetos Webflow e entregas a clientes
Sites Webflow não ficam em um repositório Git, mas agências ainda precisam de documentação quando um site muda de mãos. O preset Site Webflow gera um README de entrega: coleções do CMS, integrações, onde ficam os códigos personalizados (configurações do site vs. configurações da página), o sistema de nomenclatura (por exemplo Client-First) e a stack técnica. Guarde-o na pasta do projeto ou cole em uma página do Notion. Combine com o Verificador de erros de digitação em nomes de classe antes da entrega e adicione um llms.txt para que assistentes de IA também entendam o site.
Dicas de escrita
- Comece pelo resultado, não pela tecnologia: “Transforme qualquer texto em um slug seguro para URL” é melhor que “Um utilitário em TypeScript que usa normalização Unicode”.
- Deixe os exemplos prontos para copiar e executáveis — sem placeholders que quebram ao colar.
- Use links relativos para arquivos do repositório (
./docs/setup.md,LICENSE) para que funcionem em forks e branches. - Mantenha atualizado: um comando de instalação desatualizado causa mais dano do que um README curto.
- Documentação de referência longa deve ficar na pasta
/docs; linke para ela a partir do README.
Como escolher uma licença
Sem licença, o código fica “todos os direitos reservados” por padrão — outras pessoas podem ler, mas não reutilizar legalmente. MIT e ISC são curtas e permissivas, Apache 2.0 acrescenta uma concessão explícita de patentes, e GPL v3 exige que as derivações continuem open source. Para trabalhos com clientes ou empresas, escolha Proprietária. Isto não é aconselhamento jurídico; consulte choosealicense.com para mais detalhes. Não esqueça de adicionar também o arquivo LICENSE correspondente.
Precisa ajustar o texto antes? O conversor Markdown para HTML, o Conversor de lista de tarefas em Markdown e o JSON para tabela Markdown geram Markdown no estilo GitHub que você pode colar no README.
Também pesquisado como: readme.md, modelo de readme, readme github, criar readme, documentação de projeto, readme npm, gerador readme.md online, documentação webflow.
Ferramentas que combinam com: Gerador de README
- Gerador de LICENSE — Adicione a licença open source certa ao seu projeto em segundos.
- Gerador de humans.txt — Crie um humans.txt que dá crédito à equipe, aos colaboradores e às tecnologias por trás do seu site.
- Formatador HTML — Cole HTML minificado ou bagunçado e receba um código limpo e com indentação consistente, incluindo os blocos <style> e <script> embutidos.
- Formatador de CSS — Transforme uma folha de estilo minificada em CSS legível, com uma propriedade por linha e blocos @media aninhados corretamente.
Perguntas frequentes
Onde eu coloco o arquivo README.md?
README.md na página do projeto.