词映 AI导航
工具库Skills 技能
我的收藏
词映 AI导航

Claude Code create-readme：从项目配置编写 README

English

Claude Code 安装步骤

  1. 打开 GitHub 固定提交的 `.claude/skills/create-readme/SKILL.md`，核对内容与使用条件。
  2. 在自己的项目中创建 `.claude/skills/create-readme/`，把核对后的文件保存为 `.claude/skills/create-readme/SKILL.md`。
  3. 在该项目根目录启动 Claude Code，在斜杠菜单中选择 `/create-readme`。

中文摘要

先核对项目结构和可运行入口，再用 GitHub Flavored Markdown 编写简洁的项目介绍和启动说明。

SKILL.md 中文导读

可复现示例

示例工具 meter-05 的项目文件名为 MeterSample.csproj。开发记录给出启动命令“dotnet run --project MeterSample.csproj”，当前已有独立 LICENSE 和 CHANGELOG.md。

工作步骤

  1. 查看项目配置、启动入口和现有文档，摘出有依据的步骤。
  2. 生成简洁 README，复核路径、命令和需要保留的原有文档。

验收方法

README 应说明该工具的用途，将“dotnet run --project MeterSample.csproj”保留在启动步骤；已有许可证和变更记录各自在原有文件维护。

GitHub 原文 · 更新日期

适用环境

在 Claude Code 中打开要编写文档的项目，确认构建配置、启动入口和任何已有的项目素材。

常见问题

README 中的命令如何避免写错？

先从实际的项目配置及入口核对目录和项目名，再把已确认的命令写入启动说明。

相关指南