Docs

README Generator

Generate a README from bullet notes, or paste an existing README to edit with a live preview. Optionally ask AI to polish your draft.

Privacy: Editing and preview run in your browser. AI calls use Codeground's self-hosted model and are not stored or used for training.

AI can make mistakes. Please review important output before you rely on it.

Project notes

213 / 10000 chars

Create, edit, and preview READMEs in one place

Start from rough notes and let AI draft a structured README, or paste an existing file and edit it with a live GitHub-style preview. Tweak headings, commands, and examples — then copy the final Markdown.

Two workflows

  • Generate from notes: bullet specs → AI draft → edit in the split editor.
  • Edit & preview: paste any README, change it directly, preview updates instantly.
  • Improve with AI: optional polish pass that preserves your facts.

FAQ

Does preview need the server? No — rendering runs entirely in your browser.

Will AI invent features? The model is instructed to preserve your content and only restructure or clarify.