Is this free README generator really free?

Yes. Every tool on freemarkdowntools.com is free forever.

Does it include badges?

Yes. Toggle 'Include badges' to add npm version, license, and build-status badges from shields.io.

What templates are available?

Minimal (title + description + license), Standard (adds features + usage), Library (adds API section), and Web App (adds Getting Started with repo clone).

Can I edit the generated Markdown?

Yes. The output is regular Markdown — paste it into any editor and customize further.

No. The tool runs 100% in your browser.

README 生成器

几分钟内创建完美的 GitHub README。

Template:

项目名称标语描述作者名称 GitHub 用户名安装命令 Usage code example 许可证

可选章节包含徽章包含贡献指南包含测试

README.md 764 字符

![npm version](https://img.shields.io/npm/v/my-awesome-project)
![license](https://img.shields.io/badge/license-MIT-blue)
![build](https://img.shields.io/github/actions/workflow/status/username/my-awesome-project/ci.yml)

# My Awesome Project

> A short, memorable one-liner

A longer description of what this project does and who it's for.

## Features

- ✨ Feature one
- 🚀 Feature two
- 🔒 Feature three

## Installation

```bash
npm install my-awesome-project
```

## Usage

```js
import { doThing } from "my-awesome-project";

const result = doThing({ foo: "bar" });
console.log(result);
```

## Contributing

Contributions are welcome! Please open an issue first to discuss what you'd like to change, then submit a pull request.

## License

MIT © Your Name

概述 — 免费 README 生成器的功能

这个免费工具是什么

免费 README 生成器通过简短的表单生成完美的 GitHub README.md。选择模板（精简版、标准版、库版或 Web 应用版），填写项目名称、描述、作者、安装命令和使用代码——几秒钟内即可获得精美的 README。徽章、许可证、贡献指南和测试说明都只需一个开关即可添加。

隐私: 此工具完全在您的浏览器中运行。您的文本不会被上传、记录或缓存。关闭标签页即消失。可在开发者工具 → 网络中验证：零请求发出。

为什么免费（以及我们如何保持免费）

好的 README 决定了一个开源项目是被人使用还是被人遗忘。我们希望每个免费工具、每个独立库、每个业余项目都有一份像样的 README。这就是它永久免费的原因。

使用概览

速查参考

输入	输出	典型大小	速度	需要登录
Form fields	README.md (GitHub-ready)	Any project	Real-time	No

README 生成器功能

以下是此免费工具的详细功能 — 每项功能都旨在解决实际问题，完全在浏览器中运行，永久免费。

4 种项目模板

选择匹配项目类型的模板：精简版（标题 + 描述 + 许可证，适合小型工具库）、标准版（增加功能和使用说明，适合典型开源项目）、库版（增加 API 部分及函数签名，适合可复用库）或 Web 应用版（增加快速开始部分及仓库克隆和开发服务器说明）。每个模板都会预填充相应分区。

生成 README 后，可使用免费 Markdown 转 HTML 转换器预览在项目主页上的渲染效果。

自动生成 Shields.io 徽章

开启包含徽章可在 README 顶部添加 shields.io 徽章——npm 版本号、许可证和 GitHub Actions 构建状态。徽章根据项目名和 GitHub 用户名生成，项目发布后会自动更新。

为 README 各分区生成目录，可使用免费 Markdown 目录生成器。

内置 6 种开源许可证

可从 MIT、Apache 2.0、GPL-3.0、BSD 3-Clause、ISC 和 Unlicense 中选择——6 种最常用的开源许可证。README 的许可证部分会即时更新，徽章也会同步变化。

如果 README 需要包含表格（功能对比、配置选项），免费 Markdown 表格生成器可可视化构建表格。

可选的贡献指南和测试说明

切换贡献指南可添加欢迎 Pull Request 和 Issue 的说明。切换测试可添加运行测试套件的说明（默认为 npm test，复制后可修改）。精简版模板中两者默认关闭；其他模板中默认开启。

生成后可使用免费 Markdown 格式化工具整理格式。

如何使用免费 README 生成器

步骤 1 — 选择模板

根据项目类型选择精简版、标准版、库版或 Web 应用版。

步骤 2 — 填写表单

项目名称、标语、描述、作者、安装命令、使用代码、许可证。

步骤 3 — 复制并粘贴

点击复制 README 或下载 README.md，将其放在项目根目录。

谁可以使用此工具

Open source maintainers

Shipping a polished README for every library release — no more 'figure out how to use this' friction.

Indie developers

Ship side projects with professional READMEs that make them look like real products.

Students building portfolios

Every project on your GitHub profile needs a README. This takes 2 minutes.

Hackathon teams

Ship your hackathon project with a real README even when you're running on 3 hours of sleep.

Technical writers

Starting from a solid template and customizing instead of staring at a blank file.

常见问题

这个 README 生成器真的免费吗？

是的。freemarkdowntools.com 上的所有工具永久免费。

包含徽章吗？

是的。默认包含 shields.io 的 npm 版本号、许可证和构建状态徽章。不需要可关闭。

有哪些模板可用？

精简版（标题 + 许可证）、标准版（增加功能 + 使用说明）、库版（增加 API 部分）、Web 应用版（增加快速开始及仓库克隆）。

可以编辑生成的 Markdown 吗？

可以。输出是标准 Markdown——复制后可在任何编辑器中进一步自定义。

我的数据会被存储吗？

不会。工具 100% 在浏览器中运行。

概述 — 免费 README 生成器 的功能