MarkdownForge

README generator

Answer a few questions and get a complete README.md: title, badges, features, install, usage, contributing and license. Or let AI write a first draft from a description.

Project details
Write at least a sentence or two.
README.md

Anatomy of a good README

  1. Name and one-liner. A visitor decides in seconds whether the project is relevant. Say what it does, not how it’s built.
  2. Badges (optional). Build status, version, license. Keep it to a handful; a wall of badges is noise.
  3. Features. Three to six bullets of what it can do for the reader.
  4. Installation. Copy-pasteable commands in a fenced code block, with prerequisites stated first.
  5. Usage. The smallest working example. A screenshot or Mermaid diagram helps for anything visual.
  6. Contributing and license. How to help, and under what terms people can use the code.

README tips

  • Write for someone who has never seen the project. Avoid internal jargon.
  • Keep long reference docs in a docs/ folder and link to them.
  • Use relative links to files in the repo ([license](LICENSE)) so they work on forks.
  • Check the result in the Markdown editor or viewer before committing.

Questions people ask

What should a README include?
At minimum: what the project is, how to install it, how to use it, and its license. Good READMEs add a short feature list, configuration, how to contribute and where to get help. GitHub’s own docs recommend covering what the project does, why it is useful, how to get started, where to get help, and who maintains it.
How does the README generator work?
Fill in the form and the README.md is assembled live from your answers using a standard structure. Sections you leave empty are skipped. Nothing is sent anywhere.
What does “Draft with AI” do?
You describe the project in a few sentences and an AI model writes a first draft of the whole README, which appears in the editor for you to correct. It is told not to invent URLs, badges or version numbers.
Where do I put the README?
Save it as README.md in the root of your repository. GitHub, GitLab and Bitbucket show it on the project’s front page. On GitHub, a README in a repository named after your username becomes your profile page.

Related tools

MF-01Markdown editorSplit-pane editor with live preview, autosave and exportsMF-12Mermaid live editorDiagrams as code, with SVG and PNG exportMF-09Table generatorEdit a grid, set alignment, copy the tableMF-11Markdown formatterPrettier formatting, aligned tables, TOC