DocuWriter.ai — README Generator

Produce a professional README.md for any repository—tailored to the sections you pick.

1 · Why Use It?

  • Consolidates key project info into a single, polished Markdown file.
  • Checkbox‑driven: include only the sections you need (Introduction, Usage, License, etc.).
  • Supports multiple licenses and output languages.
  • Stores the result in Generations and optionally a Space.

2 · Launching the Tool

Git Connections › README generation

3 · Configuration Walk‑Through

Field / Option Purpose
**Git connection *** Choose a repository previously added in Git Connections.
Options (checkboxes) Tick the sections to appear in the README: Introduction, Features, Requirements, etc.
**License *** Select a SPDX‑style license (Apache‑2.0, MIT, GPL‑3.0, …). Appears under License header.
**Output language *** Language for autogenerated prose (code & section titles remain unchanged).
Additional instructions (optional) Provide extra context (e.g. "Highlight Docker usage").

Tip → You can regenerate the README with a different mix of checkboxes anytime.

4 · Generating Your README

  1. Complete the fields and click Start generating ✨.
  2. The pane displays the rendered Markdown, complete with syntax highlighting and headings.

5 · Post‑Generation Controls

Button / Menu Action
Edit Opens an in‑browser Markdown editor.
Download ⏷ Saves README.md to your machine.
Add to my Space Inserts the README into a chosen Space page.
Share Produces a unique, read‑only link (expiry optional).

7 · Troubleshooting

Issue Solution
Repo not visible Ensure it's synced under Git Connections → Add Repository.
Missing section Re‑run with the checkbox enabled or add it via Edit.
Wrong license text Switch license dropdown and regenerate.

Need Help?

Email [email protected]