AI README Generator
Genera un README.md professionale per il tuo progetto con l'intelligenza artificiale. Compila i campi e lascia che la AI costruisca una documentazione completa e ben strutturata.
Dettagli del progetto
La licenza scelta viene inclusa automaticamente nel README generato.
Come funziona
Descrivi il progetto
Inserisci nome, descrizione, tech stack e feature. Più dettagli fornisci, migliore sarà il risultato.
La AI genera il README
L'intelligenza artificiale costruisce un README.md completo con sezioni di installazione, utilizzo e contribuzione.
Copia e usa subito
Copia il Markdown con un click e incollalo nel tuo repository. Personalizzabile a piacere.
Come utilizzare AI README Generator
Insert project details
Fill in the name and a clear description (max 500 characters) of your project; description is most important field: explain what it does, who's target audience is and how – concisely but precisely
Specify tech stack and functionality
List the technologies used (e.g., "Angular, Spring Boot, PostgreSQL") and main features, one per line. More details will result in a more specific README.
Choose the license and generate the README
Select an appropriate license (MIT for open-source projects, Apache for enterprise use, none for private projects) and click “Generate README”. Copy the resulting Markdown directly into your repository’s file README.md.
Suggerimenti
- Write project description in English if your GitHub repository is public: reaching an international audience will be wider and increase chances of contributions.
- List features one per line in dedicated field: AI will format them as bulleted list in the README for easier reading by potential users of your project.
- After generating README, add status badges (build, coverage, version) manually; shield.io offers ready-to-use badges for any public repository.
Domande frequenti
Which license should I choose for my open-source project?
MIT is the most common choice: permissive, easy to understand, and accepted by most organizations. Apache 2.0 adds explicit patent protection. GPL 3.0 is the right choice if you want forks to maintain the same level of openness (copyleft). For private projects select “No license”.
Can I use the generated README directly on GitHub?
Yes, it’s standard Markdown compatible with GitHub, GitLab, and Bitbucket. Copy the text into the area provided, create a file named README.md in your repository's root directory, and paste it there.
Does AI include sections like installation and contribution?
Yes. The model generates a structured README with standard sections: description, requirements, installation, usage, features, contributions, and license. Sections are populated based on the information provided; more details will result in better output.
Is the generated README saved or sent to third parties?
No, data entered into the form (name, description, tech stack, feature) is not persisted server-side. Generation occurs through AI endpoint of backend using Ollama on-prem (llama3.1:8b), executed on author’s infrastructure without any external cloud provider.
What if the generated README isn’t detailed enough?
Go back to form and enrich Tech Stack and Features fields with more specific information (frameworks, versions, installation commands). Then regenerate it; you can also manually modify resulting Markdown before copying into your repository: output is a starting point, not final README.