Gerador de README.md para o seu projeto
Preencha o nome, o que o projeto faz e como instalar, e copie ou baixe o README.md pronto, com pré-visualização. Tudo no navegador.
README completo
Dados do projeto
É a única parte obrigatória.
Uma ou duas frases para quem nunca ouviu falar dele.
O problema que ele resolve e o que o diferencia.
Um por linha.
Um por linha. Ex.: Node.js 20 ou mais novo.
Os comandos, um por linha. Saem em um bloco de código.
Issues, discussões, e-mail ou chat.
Não sabe qual escolher? Veja o codigolivre.dev, que explica cada licença.
Uma pessoa ou grupo por linha.
Suas escolhas ficam só neste navegador, para você não redigitar. Nada é enviado.
O que um README precisa ter?
Dizer o que o projeto faz, por que é útil, como começar, onde pedir ajuda e quem o mantém. O gerador monta essas seções na ordem e avisa o que ficou faltando.
O que o gerador escreve
O README gerado segue as cinco perguntas que a documentação do GitHub diz que o arquivo deve responder: o que o projeto faz, por que é útil, como começar, onde pedir ajuda e quem o mantém. As seções saem nesta ordem e só aparecem se você preencher o campo: título e resumo, Por que usar, Recursos, Requisitos, Instalação, Uso, Testes, Onde pedir ajuda, Como contribuir, Segurança, Licença e Mantenedores.
Os comandos que você digita nos campos de instalação, uso e testes viram blocos de código. Se algum deles tiver três crases seguidas, o gerador usa uma cerca maior para o bloco não quebrar. Nenhum HTML é escrito, e a pré-visualização mostra o texto do jeito que ele é, sem interpretar HTML digitado por você. Imagens não são carregadas na pré-visualização: o site não faz nenhum pedido a servidores de fora.
Os arquivos que você marca como existentes (CONTRIBUTING, CODE_OF_CONDUCT e SECURITY) viram links relativos, que continuam funcionando em outras branches e em clones. A licença é escolhida entre nove identificadores da lista SPDX; para decidir qual usar, veja o codigolivre.dev.
Exemplo resolvido: o README do listaki
- Nome listaki e uma frase sobre guardar tarefas em um arquivo de texto.
- Três recursos e um requisito (Node.js 20 ou mais novo).
- Instalação em três comandos, exemplo de uso em dois e o comando dos testes.
- CONTRIBUTING e CODE_OF_CONDUCT marcados como existentes; licença MIT.
O resultado tem o título e 10 seções, passa sem nenhum aviso e cabe em uma tela e meia. Os nomes, o usuário e os endereços são inventados para o exemplo (SEU-USUARIO é um marcador a trocar).
README.md
# listaki Uma ferramenta de linha de comando para guardar tarefas em um arquivo de texto, sem conta e sem internet. ## Por que usar Quem vive no terminal não precisa abrir outro aplicativo para anotar o que falta fazer. As tarefas ficam num arquivo .txt que você pode versionar com o Git. ## Recursos - Adicionar, listar e concluir tarefas- Filtrar por etiqueta- Saída em texto simples ou em JSON ## Requisitos - Node.js 20 ou mais novo ## Instalação ```bashgit clone https://github.com/SEU-USUARIO/listaki.gitcd listakinpm install``` ## Uso ```bashnpx listaki add "escrever o README" --etiqueta docsnpx listaki list``` ## Testes ```bashnpm test``` ## Onde pedir ajuda Abra uma issue neste repositório descrevendo o que você tentou e o que apareceu na tela. ## Como contribuir Contribuições são bem-vindas. Antes de abrir um pull request, leia o [CONTRIBUTING.md](CONTRIBUTING.md). Este projeto adota um código de conduta: veja o [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). ## Licença Distribuído sob a licença MIT (identificador SPDX: `MIT`). Veja o arquivo [LICENSE](LICENSE). ## Mantenedores - Maria Souza (@msouza)Os campos e o que cada um vira
| Campo | Seção gerada | Obrigatório |
|---|---|---|
| Nome do projeto | Título (#) | sim |
| O que o projeto faz | Frase logo abaixo do título | não, mas o gerador avisa |
| Por que usar | Por que usar | não |
| Recursos e Requisitos | Listas com marcadores | não |
| Como instalar, Exemplo de uso, Comando dos testes | Blocos de código | não, mas o gerador avisa da instalação |
| Onde pedir ajuda | Onde pedir ajuda | não, mas o gerador avisa |
| Arquivos do repositório | Como contribuir e Segurança, com links | não |
| Licença | Licença, com o identificador SPDX | não, mas o gerador avisa |
Como usar o arquivo gerado
- Preencha o formulário. O que você digita é guardado só neste navegador, para não precisar redigitar, e os botões “Começar do zero” e “Ver o exemplo” apagam ou restauram tudo.
- Confira a pré-visualização e os avisos. O gerador diz se faltam o resumo, a instalação, onde pedir ajuda ou a licença.
- Copie o texto ou baixe o arquivo
README.mde coloque-o na raiz do repositório. O GitHub também procura o arquivo em.githube emdocs. - Faça o commit e envie. Se ainda não fez isso, o passo a passo da primeira contribuição mostra os comandos.
Perguntas frequentes
O que um README precisa ter?
A documentação do GitHub diz que o README deve contar o que o projeto faz, por que é útil, como começar, onde pedir ajuda e quem o mantém. O gerador monta essas seções na ordem e avisa o que está faltando, como o resumo, a instalação e a licença.
O README gerado tem imagens ou selos?
Não. O arquivo é Markdown puro, sem HTML e sem distintivos que dependam de servidor de terceiros. Se quiser acrescentar imagens, faça isso depois no seu editor. A pré-visualização também não carrega imagens, para nada sair do seu navegador.
Qual licença escolher?
O gerador lista nove identificadores da lista SPDX (versão 3.29.0) e não decide por você. Para entender o que cada licença permite e exige, veja o codigolivre.dev. A Open Source Guides diz que um projeto aberto deve ter uma licença desde o lançamento; por isso o gerador avisa quando você deixa em branco.
O que escrever em Onde pedir ajuda?
O lugar onde a pessoa deve perguntar: a aba Issues, as Discussions, um e-mail ou um chat. Seja específico sobre o que vai em cada canal, para evitar perguntas no lugar errado. A documentação do GitHub lista essa informação entre as cinco que o README deve ter.
Onde coloco o arquivo gerado?
Na raiz do repositório, com o nome README.md. O GitHub também procura em .github e em docs e mostra o de .github primeiro, depois o da raiz, depois o de docs. Depois de baixar, faça o commit e o push.
Fontes desta página
Abertas em 11/10/2026. Nenhuma das duas mostra data.
- About the repository README file (GitHub Docs)
A página não mostra data · aberta em · reconferência: confirmada na abertura (11/10/2026) · licença do conteúdo: CC BY 4.0 (conteúdo); MIT (código)
O que lemos: O que um README deve dizer (o que o projeto faz, por que é útil, como começar, onde pedir ajuda, quem mantém), onde o GitHub o procura (.github, raiz, docs, nessa ordem), o corte em 500 KiB e o uso de links relativos.
Como usamos: Texto próprio em português; os fatos e os comandos vêm da página, sem copiar trechos. Link e data em cada uso. - Starting an Open Source Project (Open Source Guides)
A página não mostra data · aberta em · reconferência: confirmada na abertura (11/10/2026) · licença do conteúdo: CC BY 4.0
O que lemos: O README responde o que o projeto faz, por que é útil, como começar e onde pedir ajuda; deve ser escrito para quem não é você; um projeto aberto deve ter licença desde o lançamento; o código de conduta, o CODE_OF_CONDUCT na raiz, linkado do README.
Como usamos: Texto próprio em português; os fatos e os comandos vêm da página, sem copiar trechos. Link e data em cada uso. - SPDX License List (spdx.org)
Data na página: 16/09/2026 · aberta em · reconferência: confirmada na abertura (11/10/2026) · licença do conteúdo: não confirmada
O que lemos: Versão 3.29.0 da lista, de 16/09/2026. Conferi que MIT, Apache-2.0, BSD-3-Clause, ISC, MPL-2.0, GPL-3.0-only, AGPL-3.0-only, Unlicense e CC0-1.0 estão na lista sem marca de obsoleto; GPL-3.0 está marcado como obsoleto.
Como usamos: Só os identificadores (nomes curtos), conferidos um a um.
Continue por aqui
Os geradores, o passo a passo e os guias ficam a um clique.
- Primeira contribuiçãoDo fork ao pull request, com os comandos de git para copiar.
- Gerador de CONTRIBUTINGDiga como o projeto recebe ajuda e copie o arquivo.
- Mensagem de commitMonte e valide a mensagem no padrão Conventional Commits.
- Praticar no terminalTerminal de faz de conta: do clone ao push, sem mexer em repositório de verdade.
- Guias16 guias curtos, cada um com a fonte oficial aberta e a licença.