Gerador README

Utilização comercial OK Modelos 581 Sem marca de água Não é necessário registo
Modelo:
+ GPT-5, Claude, Gemini
Descreva o seu projeto (ou cole package.json / pyproject.toml / Cargo.toml) e volte a um README.md polido — título, escudos, instale, Quickstart, funcionalidades, contribuindo, licença. Escolha o seu tipo de projeto, comprimento e tom.
Incluir:
-
Descreva o seu projeto.
README.md

        
Opções avançadas
Resultado
Os tokens estão a ficar baixos. Obter mais tokens
Queres melhores resultados? Modelos premium (GPT-5, Claude, Gemini) oferecem uma qualidade superior. Ver Planos

❤️ Adoro Free.ai? Diga aos seus amigos!

Inscreva-se para obter um link de referência e ganhar 30.000 fichas por amigo.

Queres mais? Inscreva-se gratuitamente: 30 000 fichas/dia
Inscreva-se livre

Tratamento do seu pedido...

Gere arquivos README do projeto com IA gratuita. Documentação profissional em segundos.

Como Utilizar Gerador README

1
Introdução

Digite texto, carregue um arquivo ou describa o que você quer. Não é necessária nenhuma conta.

2
Clique em gerar

Nossa IA processa o seu pedido em segundos usando os melhores modelos de código aberto.

3
Baixar & compartilhar

Baixe, copie ou compartilhe o seu resultado. Gratuito para uso pessoal e comercial.

Use esta ferramenta através da API

Automate esta ferramenta a partir do seu próprio código. Endpoint REST compatível com o OpenAI, Bearer-token auth, não é necessário SDK extra. O token custa corresponder à interface web.

curl -X POST https://api.free.ai/v1/chat/ \
  -H "Authorization: Bearer sk-free-..." \
  -H "Content-Type: application/json" \
  -d '{"model": "qwen-coder", "messages": [{"role": "user", "content": "Write a Python function that reverses a string."}]}'

Gerador README - FAQ

Descreva o seu projeto em 2-3 frases (ou paste package.json / pyproject.toml / Cargo.toml) e volte a um README.md polido - título, crachás de escudo, tabela de conteúdos, instalar, rápidos arranque, características, uso, contribuição opcional / licença / secções FAQ. Escolha o tipo de projeto (libraria / CLI / webapp / API / mobile / plugin / dataset / papel / template), comprimento (minima → exaustivo), e tono (professional / amigável / técnico / marketing / acadêmico).

readme-so e makeareadme.com são modelos de preenchimento de formulários — você seleciona manualmente caixas e obtém seções de estoque. Free.ai é gerativo — escreve cópia específica para O PROJECTO, inferindo comandos de instalação razoáveis / forma de API / tom da sua descrição.Copilot ($10/mo) é inline-IDE e gera parágrafo de texto README, conforme você escreve; Free.ai produz todo o arquivo em uma única injeção. Use readme-so para a estrutura pura; Free.ai quando você quer cópia real.

O prompt do sistema proíbe explicitamente inventar funcionalidades. Se a descrição for vaga, o modelo insere marcadores "TODO". Leia sempre o README gerado e remova TODO (ou substitua o conteúdo real) antes de publicar — trate a saída como um primeiro esboço polido, não um arquivo pronto para navegar.

Sim, quando selecionado — uma linha de 3-6 escudos (construir, versão, licença, downloads, cobertura) usando URLs de substituto que você personaliza para o seu repo. O modelo escolhe padrão sensato baseado no tipo de projeto (libraria recebe npm-version ou pypi-version; CLI obtém contagem de instalação; webapp fica uptime).

Minimal (10 linhas) para utilidades internas ninguém vai descobrir. Standard (~80 linhas) para a maioria dos projetos de código aberto - atinge o spot doce de localização sem paredes de texto. Detalhado (~200 linhas) para projetos que você comercializa ativamente. Exhaustivo (estilo de doutores, 300+ linhas) quando o README é o seu site principal de documentos.

Sim - escolhe o tom "Marketing". Você tem um título forte, cópia com benefícios, porta-locais à prova de social, CTAs mais fortes. As seções permanecem precisas (não inventaram características) mas a prosa é estilo de lançamento. Bom para SaaS repos, projetos de portfólio, lançamentos de estilo caça de produtos.

Sim - escolha o tom "Academic". O README inclui uma seção "Citação" com um modelo BibTeX e uma linha de solicitação-se-utilizada, além de métodos e campos de reprodutibilidade.

Sim - o painel de resultados tem botões de commutação Markdown/Preview. Vista preliminar rende o lado do cliente com um subconjunto de sabor GitHub (capitulações, bold/italic, blocos de código, código inline, listas, links). Não tão polido como o próprio GitHub - fazer sempre um teste final pressionando para uma repo.

O gerador padrão assume um único projeto README. Para uma raiz monorepo README, descreve o repo como um monorepo em seu input ("contém 3 pacotes: foo, bar, baz") - o modelo adiciona uma tabela de pacotes e salta instruções de instalação (porque a instalação é por pacote). Para o por pacote READMEs, execute Gerador README uma vez por pacote.

Qwen 3 Coder (gratuito, padrão) maneja 95% de READMEs bem. Qwen 3 30B é mais polido e equilibrado no tom de marketing. Premium Claude Sonnet 4 é noteavelmente melhor na cópia de tonalidade de marketing e no comprimento exaustivo READMEs — vale o valor dos tokens pagas para o seu landing-page repo.

A descrição é enviada para o modelo, processado e descartado. Não armazenado, não utilizado para treinamento. Para a máxima privacidade escolhe Qwen 3 Coder - auto-hosted em Free.ai GPUs.

Sim - POST to /v1/chat/ com o prompt sistema README (tipo + comprimento + ton + seção bandeiras) e a descrição do projeto como a mensagem do usuário. Útil para automatizar a geração README durante o andaime do projeto. Veja /api /.

Inscreva-se gratuitamente: 30 000 fichas/dia

Criar Conta Livre

Não é necessário cartão de crédito

Como você avalia esta ferramenta?

Adoro Free.ai? Diga aos seus amigos!