Resumo — O que Gerador de README faz
O que é esta ferramenta gratuita
O Gerador de README Gratuito cria um README.md perfeito para o GitHub a partir de um formulario curto. Escolha um template (Minimal, Standard, Library ou Web App), preencha nome do projeto, descricao, autor, comando de instalacao e codigo de uso — e obtenha um README polido em segundos. Badges, licenca, secao de contribuicao e secao de testes estao a um toggle de distancia.
Privacidade: Esta ferramenta roda inteiramente no seu navegador. Seu texto nunca é enviado, registrado ou armazenado em cache. Feche a aba e tudo desaparece. Verifique em DevTools → Network: zero requisições.
Por que é gratuita (e como mantemos assim)
Bons READMEs sao a diferenca entre um projeto open-source que as pessoas usam e um que as pessoas esquecem. Queremos que toda ferramenta gratuita, toda biblioteca indie, todo projeto paralelo tenha um README decente. Por isso e gratuito para sempre.
Tabela de uso
Referência rápida
| Entrada | Saída | Tamanho típico | Velocidade | Login necessário |
|---|
| Form fields | README.md (GitHub-ready) | Any project | Real-time | No |
Funcionalidades de Gerador de README
Veja o que esta ferramenta gratuita faz em detalhes — cada funcionalidade é projetada para resolver problemas reais, roda inteiramente no seu navegador e é gratuita para sempre.
4 Templates para Diferentes Tipos de Projeto
Escolha o template que combina com seu projeto: Minimal (titulo + descricao + licenca, para bibliotecas utilitarias pequenas), Standard (adiciona secoes de funcionalidades e uso, para projetos open-source tipicos), Library (adiciona secao de API com assinaturas de funcoes, para bibliotecas reutilizaveis) ou Web App (adiciona secao de Primeiros Passos com instrucoes de clone e servidor de desenvolvimento). Cada template preenche as secoes apropriadas.
Uma vez que tiver o texto do README, voce pode renderiza-lo em HTML com o Conversor Gratuito de Markdown para HTML para visualizar como ficara na pagina do projeto.
Badges Shields.io Gerados Automaticamente
Ative Incluir badges para adicionar uma linha de badges shields.io no topo do seu README — versao npm, licenca e status de build do GitHub Actions. Os badges sao gerados a partir do nome do seu projeto e usuario GitHub, entao atualizam automaticamente uma vez que seu projeto for publicado.
Para um sumario linkando cada secao do README, use o Gerador de Sumario Markdown Gratuito na saida gerada.
Seletor de Licenca com 6 Opcoes Open-Source
Escolha entre MIT, Apache 2.0, GPL-3.0, BSD 3-Clause, ISC ou Unlicense — as 6 licencas open-source mais comuns. A secao de Licenca do README atualiza instantaneamente, e se os badges estiverem habilitados, o badge de licenca atualiza para corresponder.
Se o README do seu projeto precisar incluir tabelas (comparacoes de funcionalidades, opcoes de configuracao, variaveis de ambiente), o Gerador de Tabelas Markdown Gratuito as constroi visualmente.
Secoes Opcionais de Contribuicao e Testes
Ative ou desative a secao Contribuicao para incluir um texto acolhedor convidando pull requests e relatos de problemas. Ative a secao Testes para incluir instrucoes para executar sua suite de testes (padrao npm test, editavel apos copiar). Ambos estao desativados por padrao no template Minimal; ativados por padrao nos outros.
Apos gerar, limpe quaisquer inconsistencias com o Formatador de Markdown Gratuito.
Como usar Gerador de README
Passo 1 — Escolha um template
Escolha Minimal, Standard, Library ou Web App dependendo do tipo do seu projeto.
Passo 2 — Preencha o formulario
Nome do projeto, tagline, descricao, autor, comando de instalacao, codigo de uso, licenca.
Passo 3 — Copie e cole
Clique em Copiar README ou Baixar README.md e coloque na raiz do seu projeto.
Quem pode usar esta ferramenta
Open source maintainers
Shipping a polished README for every library release — no more 'figure out how to use this' friction.
Indie developers
Ship side projects with professional READMEs that make them look like real products.
Students building portfolios
Every project on your GitHub profile needs a README. This takes 2 minutes.
Hackathon teams
Ship your hackathon project with a real README even when you're running on 3 hours of sleep.
Technical writers
Starting from a solid template and customizing instead of staring at a blank file.
Perguntas frequentes
Este gerador de README gratuito e realmente gratuito?
Sim. Todas as ferramentas do freemarkdowntools.com sao gratuitas para sempre.
Inclui badges?
Sim. Badges shields.io para versao npm, licenca e status de build sao incluidos por padrao. Desative se nao quiser.
Quais templates estao disponiveis?
Minimal (titulo + licenca), Standard (adiciona funcionalidades + uso), Library (adiciona secao de API), Web App (adiciona Primeiros Passos com clone do repositorio).
Posso editar o Markdown gerado?
Sim. A saida e Markdown regular — copie, cole e personalize em qualquer editor.
Meus dados sao armazenados?
Nao. A ferramenta roda 100% no seu navegador.
Ferramentas Markdown gratuitas relacionadas