Skip to content
Toggle navigation
P
Projects
G
Groups
S
Snippets
Help
赵月辉
/
hermes-skills
This project
Loading...
Sign in
Toggle navigation
Go to a project
Project
Repository
Issues
0
Merge Requests
0
Pipelines
Wiki
Snippets
Members
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Commit
23fb05eb
authored
Jun 23, 2026
by
Hermes Desktop
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
feat(skills): update generate-readme
parent
311a0a25
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
60 additions
and
0 deletions
+60
-0
generate-readme/SKILL.md
+60
-0
No files found.
generate-readme/SKILL.md
0 → 100644
View file @
23fb05eb
---
name
:
generate-readme
description
:
生成项目 README 文件的技能,包含标准结构和必要章节
version
:
1.0.0
created
:
2026-06-22
---
# Generate Project README
生成项目 README 文件的技能,包含标准结构和必要章节。
## 触发条件
-
用户请求创建或生成项目 README
-
新项目初始化时需要文档
-
现有 README 需要重构或补充
## 步骤
1.
**收集项目信息**
-
项目名称和描述
-
技术栈/编程语言
-
主要功能特性
-
安装和使用方法
-
许可证类型
2.
**生成 README 结构**
-
标题和简介
-
特性列表
-
安装说明
-
使用示例
-
贡献指南(可选)
-
许可证信息
3.
**写入文件**
-
使用
`write_file`
创建
`README.md`
-
确保 Markdown 格式正确
4.
**验证**
-
检查文件是否存在
-
确认内容格式正确
## 常见陷阱
-
不要假设项目细节,需要用户确认关键信息
-
避免过度复杂化,保持简洁
-
确保代码示例语法正确
## 验证步骤
-
确认 README.md 文件已创建
-
检查 Markdown 渲染是否正常
-
验证所有链接和代码块格式正确
## 相关工具
-
`write_file`
- 创建 README 文件
-
`read_file`
- 检查现有文件
-
`terminal`
- 运行项目命令获取信息
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment