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

Claude Code create-readme 技能：为 Next.js 项目写快速上手文档

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 Markdown 版 README，交代功能、启动与配置。保留专用文件负责许可证和贡献说明。

SKILL.md 中文导读

可复现示例

以步道检索演示页为例。先查项目开发脚本，为本地访问写快速上手段落，列出用途和可访问地址。
`Trail Index` · `README.md` · `Quickstart` · `package.json` · `{"scripts":{"dev":"next dev"}}`

工作步骤

  1. 浏览目录与 package.json，核对开发脚本和项目用途。
  2. 用简短的 GitHub Markdown 章节写启动和访问步骤。
  3. 对照现有仓库文件，检查命令、路径和文案是否实际对应。

验收方法

`README.md` 新增 `Quickstart` 章节，演示地址写为 `http://localhost:3000`，用途说明为 `Trail Index`。启动步骤以项目的实际开发脚本为准。

GitHub 原文 · 更新日期

适用环境

在现有 Next.js 模板检出的根目录启动 Claude Code，准备 package.json、项目目录以及已经验证的启动方式。练习使用示例应用和本地环境。

常见问题

README 应该加入新的许可证段落吗？

若仓库已有 LICENSE 与贡献说明文件，保持信息由对应文件维护。README 重点写用途、启动和常见配置。

相关指南