zsp/everything-claude-code
1
0
Fork 0
mirror of https://github.com/affaan-m/everything-claude-code.git synced 2026-03-30 13:43:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #932 from KT-lcz/readme

Browse Source 
docs: fix rule installation examples
This commit is contained in:
Affaan Mustafa
2026-03-28 19:49:35 -04:00
committed by GitHub
parent 9033f2a997 67660540ac
commit d9ec51c9e9
2 changed files with 44 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -207,7 +207,7 @@ npm install # or: pnpm install | yarn install | bun install
npx ecc-install typescript npx ecc-install typescript
``` ```
For manual install instructions see the README in the `rules/` folder. For manual install instructions see the README in the `rules/` folder. When copying rules manually, copy the whole language directory (for example `rules/common` or `rules/golang`), not the files inside it, so relative references keep working and filenames do not collide.
### Step 3: Start Using ### Step 3: Start Using
@@ -638,16 +638,16 @@ This gives you instant access to all commands, agents, skills, and hooks.
> >
> # Option A: User-level rules (applies to all projects) > # Option A: User-level rules (applies to all projects)
> mkdir -p ~/.claude/rules > mkdir -p ~/.claude/rules
> cp -r everything-claude-code/rules/common/* ~/.claude/rules/ > cp -r everything-claude-code/rules/common ~/.claude/rules/
> cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ # pick your stack > cp -r everything-claude-code/rules/typescript ~/.claude/rules/ # pick your stack
> cp -r everything-claude-code/rules/python/* ~/.claude/rules/ > cp -r everything-claude-code/rules/python ~/.claude/rules/
> cp -r everything-claude-code/rules/golang/* ~/.claude/rules/ > cp -r everything-claude-code/rules/golang ~/.claude/rules/
> cp -r everything-claude-code/rules/php/* ~/.claude/rules/ > cp -r everything-claude-code/rules/php ~/.claude/rules/
> >
> # Option B: Project-level rules (applies to current project only) > # Option B: Project-level rules (applies to current project only)
> mkdir -p .claude/rules > mkdir -p .claude/rules
> cp -r everything-claude-code/rules/common/* .claude/rules/ > cp -r everything-claude-code/rules/common .claude/rules/
> cp -r everything-claude-code/rules/typescript/* .claude/rules/ # pick your stack > cp -r everything-claude-code/rules/typescript .claude/rules/ # pick your stack
> ``` > ```
--- ---
@@ -663,12 +663,13 @@ git clone https://github.com/affaan-m/everything-claude-code.git
# Copy agents to your Claude config # Copy agents to your Claude config
cp everything-claude-code/agents/*.md ~/.claude/agents/ cp everything-claude-code/agents/*.md ~/.claude/agents/
# Copy rules (common + language-specific) # Copy rules directories (common + language-specific)
cp -r everything-claude-code/rules/common/* ~/.claude/rules/ mkdir -p ~/.claude/rules
cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ # pick your stack cp -r everything-claude-code/rules/common ~/.claude/rules/
cp -r everything-claude-code/rules/python/* ~/.claude/rules/ cp -r everything-claude-code/rules/typescript ~/.claude/rules/ # pick your stack
cp -r everything-claude-code/rules/golang/* ~/.claude/rules/ cp -r everything-claude-code/rules/python ~/.claude/rules/
cp -r everything-claude-code/rules/php/* ~/.claude/rules/ cp -r everything-claude-code/rules/golang ~/.claude/rules/
cp -r everything-claude-code/rules/php ~/.claude/rules/
# Copy commands # Copy commands
cp everything-claude-code/commands/*.md ~/.claude/commands/ cp everything-claude-code/commands/*.md ~/.claude/commands/
@@ -874,7 +875,8 @@ Yes. Use Option 2 (manual installation) and copy only what you need:
cp everything-claude-code/agents/*.md ~/.claude/agents/ cp everything-claude-code/agents/*.md ~/.claude/agents/
# Just rules # Just rules
cp -r everything-claude-code/rules/common/* ~/.claude/rules/ mkdir -p ~/.claude/rules/
cp -r everything-claude-code/rules/common ~/.claude/rules/
``` ```
Each component is fully independent. Each component is fully independent.

41
README.zh-CN.md
View File

@@ -82,14 +82,17 @@
# 首先克隆仓库 # 首先克隆仓库
git clone https://github.com/affaan-m/everything-claude-code.git git clone https://github.com/affaan-m/everything-claude-code.git
# 复制规则（通用 + 语言特定） # 复制规则目录（通用 + 语言特定）
cp -r everything-claude-code/rules/common/* ~/.claude/rules/ mkdir -p ~/.claude/rules
cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ # 选择你的技术栈 cp -r everything-claude-code/rules/common ~/.claude/rules/
cp -r everything-claude-code/rules/python/* ~/.claude/rules/ cp -r everything-claude-code/rules/typescript ~/.claude/rules/ # 选择你的技术栈
cp -r everything-claude-code/rules/golang/* ~/.claude/rules/ cp -r everything-claude-code/rules/python ~/.claude/rules/
cp -r everything-claude-code/rules/perl/* ~/.claude/rules/ cp -r everything-claude-code/rules/golang ~/.claude/rules/
cp -r everything-claude-code/rules/perl ~/.claude/rules/
``` ```
复制规则时，请复制整个目录（例如 `rules/common`、`rules/golang`），而不是复制目录内的文件；这样可以保留相对引用，并避免不同规则集中的同名文件互相覆盖。
### 第三步：开始使用 ### 第三步：开始使用
```bash ```bash
@@ -366,11 +369,20 @@ everything-claude-code/
> git clone https://github.com/affaan-m/everything-claude-code.git > git clone https://github.com/affaan-m/everything-claude-code.git
> >
> # 选项 A：用户级规则（应用于所有项目） > # 选项 A：用户级规则（应用于所有项目）
> cp -r everything-claude-code/rules/* ~/.claude/rules/ > mkdir -p ~/.claude/rules
> cp -r everything-claude-code/rules/common ~/.claude/rules/
> cp -r everything-claude-code/rules/typescript ~/.claude/rules/
> cp -r everything-claude-code/rules/python ~/.claude/rules/
> cp -r everything-claude-code/rules/golang ~/.claude/rules/
> cp -r everything-claude-code/rules/perl ~/.claude/rules/
> >
> # 选项 B：项目级规则（仅应用于当前项目） > # 选项 B：项目级规则（仅应用于当前项目）
> mkdir -p .claude/rules > mkdir -p .claude/rules
> cp -r everything-claude-code/rules/* .claude/rules/ > cp -r everything-claude-code/rules/common .claude/rules/
> cp -r everything-claude-code/rules/typescript .claude/rules/
> cp -r everything-claude-code/rules/python .claude/rules/
> cp -r everything-claude-code/rules/golang .claude/rules/
> cp -r everything-claude-code/rules/perl .claude/rules/
> ``` > ```
--- ---
@@ -386,12 +398,13 @@ git clone https://github.com/affaan-m/everything-claude-code.git
# 将代理复制到你的 Claude 配置 # 将代理复制到你的 Claude 配置
cp everything-claude-code/agents/*.md ~/.claude/agents/ cp everything-claude-code/agents/*.md ~/.claude/agents/
# 复制规则（通用 + 语言特定） # 复制规则目录（通用 + 语言特定）
cp -r everything-claude-code/rules/common/* ~/.claude/rules/ mkdir -p ~/.claude/rules
cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ # 选择你的技术栈 cp -r everything-claude-code/rules/common ~/.claude/rules/
cp -r everything-claude-code/rules/python/* ~/.claude/rules/ cp -r everything-claude-code/rules/typescript ~/.claude/rules/ # 选择你的技术栈
cp -r everything-claude-code/rules/golang/* ~/.claude/rules/ cp -r everything-claude-code/rules/python ~/.claude/rules/
cp -r everything-claude-code/rules/perl/* ~/.claude/rules/ cp -r everything-claude-code/rules/golang ~/.claude/rules/
cp -r everything-claude-code/rules/perl ~/.claude/rules/
# 复制命令 # 复制命令
cp everything-claude-code/commands/*.md ~/.claude/commands/ cp everything-claude-code/commands/*.md ~/.claude/commands/