Xerador de README
Uso comercial aceptado
Máis de 380 modelos
Sen marca de auga
Non é preciso rexistrarse
Modelo:
+ GPT-5, Claude, Gemini
Describa o seu proxecto (ou apegue package. json / pyproject. toml / Cargo. toml) e obterá un README. md pulido: título, escudos, instalación, inicio rápido, características, contribucións, licenza. Escolla o tipo, a duración e o ton do seu proxecto.
Opcións avanzadas
Resultado
A faltar fichas.
Obter máis fichas
Queres máis?
Inscríbete gratis para 30K tokens/día + 10K de bonificación
Inscríbete gratis
A procesar o seu pedido...
Xere ficheiros README do proxecto con IA libre. Documentación profesional en segundos.
Como usar Xerador de README
1
Introduza a súa entrada
Escriba texto, envíe un ficheiro ou describa o que queira. Non se precisa conta.
2
Prema para xerar
A nosa IA procesa a túa solicitude en segundos empregando os mellores modelos de código aberto.
3
Obter e compartir
Obteña, copie ou comparta o seu resultado. Gratuito para uso persoal e comercial.
Empregar esta ferramenta mediante API
Automatice esta ferramenta a partir do seu propio código. Punto final REST compatíbel con OpenAI, autenticación por token de portador, non se require SDK adicional. Os custos dos tokens son iguais aos da 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."}]}'Ferramentas libres de IA relacionadas
Xerador de README — FAQ
Describa o seu proxecto en 2- 3 frases (ou apegue package. json / pyproject. toml / Cargo. toml) e obterá un README. md pulido: título, escudos, táboa de contidos, instalación, inicio rápido, características, uso, seccións opcionais de contribución / licenza / FAQ. Escolla o tipo de proxecto (biblioteca / CLI / webapp / API / móbil / extensión / conxunto de datos / papel / modelo), lonxitude (mínimo → exhaustivo) e ton (profesional / amigable / técnico / mercadotecnia / académico).
readme- so e makeareadme. com son modelos de preenchimento de formularios — sinala manualmente as opcións e obtén as seccións de stock. Free.ai é xerativo — escribe copias específicas para o SEU proxecto, inferindo comandos de instalación razoábeis / forma API / ton da súa descrición. Copilot ($10/ mes) é un IDE en liña e xera o texto README parágrafo por parágrafo mentres escribe; Free.ai produce o ficheiro enteiro dunha soa vez. Empregue readme- so para estrutura pura; Free.ai cando queira unha copia real.
O aviso do sistema prohibe explicitamente inventar características. Se a descrición é vaga, o modelo insire marcadores de posición « TODO ». Lea sempre o README xerado e elimine os TODO (ou substitúaos polo contido real) antes de publicar — trate a saída como un primeiro borrador pulido, non un ficheiro listo para enviar.
Si cando está activado — unha fila de 3- 6 escudos (compilación, versión, licenza, descargas, cobertura) usando URLs de marcador de posición que personalize no seu repositorio. O modelo escolle valores predeterminados razoábeis baseados no tipo de proxecto (a biblioteca obtén npm- version ou pypi- version; CLI obtén o número de instalacións; webapp obtén o tempo de actividade).
Mínimo (10 liñas) para utilidades internas que ninguén descubrirá. Estándar (~80 liñas) para a maioría dos proxectos de código aberto — alcanza o punto ideal de achábelidade sen paredes de texto. Detallado (~200 liñas) para proxectos que comercializa activamente. Exhaustivo (estilo documentación, máis de 300 liñas) cando o README é o seu sitio principal de documentación.
Si — escolla o ton « Comercialización ». Obterá un título forte, unha copia orientada aos beneficios, marcadores de posición a proba social, chamadas ao acto máis fortes. As seccións permanecen precisas (sen características inventadas) pero a prosa é de estilo pitch. Boa para repositorios de lanzamento de SaaS, proxectos de carteiras, lanzamentos de estilo de caza de produtos.
Si, escolla o ton « Académico ». O README inclúe unha sección « Cita » cun modelo BibTeX e unha liña de petición se se usa, ademais de campos de métodos e reprodución. Bo para repositorios de artigos de investigación e publicacións de modelos/ conxuntos de datos.
Si, o panel de resultados ten botóns de conmutación Markdown/Previsualización. A vista previa renderiza o lado do cliente cun subconxunto con sabor GitHub (cabeceiras, negrita/itálica, bloques de código, código en liña, listas, ligazóns). Non é tan pulido como o propio GitHub, sempre fai unha proba final enviando a un repositorio.
O xerador predeterminado asume un README dun só proxecto. Para un README raíz monorepo, describa o repositorio como un monorepo na súa entrada (« contén 3 paquetes: foo, bar, baz ») — o modelo engade unha táboa de paquetes e salta as instrucións de instalación (porque install é por paquete). Para README por paquete, execute a ferramenta unha vez por paquete.
Qwen 3 Coder (gratuito, por omisión) xestiona ben o 95% dos README. Qwen 2. 5 7B é un pouco máis rápido pero menos pulido no ton de mercadotecnia. Premium Claude Sonnet 4 é notablemente mellor na copia de ton de mercadotecnia e nos README de lonxitude exhaustiva - valen os tokens pagados para o repositorio da páxina de destino.
A descrición envíase ao modelo, procesándose e descartándose. Non se garda, nin se emprega para adestramento. Para máxima privacidade escolla Qwen 3 Coder — auto- hospedado nas GPU do Free.ai.
Si — POST a / v1/ chat / co prompt do sistema README (tipo + duración + ton + bandeiras de sección) e a descrición do proxecto como mensaxe do usuario. Útil para automatizar a xeración de README durante a creación do proxecto. Consulte / api /.
Como valora esta ferramenta?
5.0/5 from 1 rating