README Generator

AI

Turn a project description and stack into a complete README.md covering features, installation, usage and environment variables.

This tool sends your input to a third-party AI service (Google Gemini). Do not enter passwords, API keys or personal confidential data.

Input

Not stored

The more specific the description, the less editing the README needs.

Output

Fill in the fields on the left, then run.

How to use

  1. 1Describe the project — the more specific, the better.
  2. 2Add the stack and any extra details to reduce editing afterwards.
  3. 3Download README.md into your project root.

FAQ

Will it invent installation commands?

It does not invent on purpose: sections without enough information are omitted rather than filled with made-up version numbers or commands. Put exact steps in the extra information field.

Can it write an English README?

Yes — set the output language to English; the other fields can still be filled in Chinese.

Can I use the output commercially?

Yes, the output is yours. But AI output can be incomplete or wrong, so check the licence section and any commands before publishing.