Skip to content

Commit d9ec51c

Browse files
authored
Merge pull request #932 from KT-lcz/readme
docs: fix rule installation examples
2 parents 9033f2a + 6766054 commit d9ec51c

2 files changed

Lines changed: 44 additions & 29 deletions

File tree

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ npm install # or: pnpm install | yarn install | bun install
207207
npx ecc-install typescript
208208
```
209209

210-
For manual install instructions see the README in the `rules/` folder.
210+
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.
211211

212212
### Step 3: Start Using
213213

@@ -638,16 +638,16 @@ This gives you instant access to all commands, agents, skills, and hooks.
638638
>
639639
> # Option A: User-level rules (applies to all projects)
640640
> mkdir -p ~/.claude/rules
641-
> cp -r everything-claude-code/rules/common/* ~/.claude/rules/
642-
> cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ # pick your stack
643-
> cp -r everything-claude-code/rules/python/* ~/.claude/rules/
644-
> cp -r everything-claude-code/rules/golang/* ~/.claude/rules/
645-
> cp -r everything-claude-code/rules/php/* ~/.claude/rules/
641+
> cp -r everything-claude-code/rules/common ~/.claude/rules/
642+
> cp -r everything-claude-code/rules/typescript ~/.claude/rules/ # pick your stack
643+
> cp -r everything-claude-code/rules/python ~/.claude/rules/
644+
> cp -r everything-claude-code/rules/golang ~/.claude/rules/
645+
> cp -r everything-claude-code/rules/php ~/.claude/rules/
646646
>
647647
> # Option B: Project-level rules (applies to current project only)
648648
> mkdir -p .claude/rules
649-
> cp -r everything-claude-code/rules/common/* .claude/rules/
650-
> cp -r everything-claude-code/rules/typescript/* .claude/rules/ # pick your stack
649+
> cp -r everything-claude-code/rules/common .claude/rules/
650+
> cp -r everything-claude-code/rules/typescript .claude/rules/ # pick your stack
651651
> ```
652652
653653
---
@@ -663,12 +663,13 @@ git clone https://github.com/affaan-m/everything-claude-code.git
663663
# Copy agents to your Claude config
664664
cp everything-claude-code/agents/*.md ~/.claude/agents/
665665
666-
# Copy rules (common + language-specific)
667-
cp -r everything-claude-code/rules/common/* ~/.claude/rules/
668-
cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ # pick your stack
669-
cp -r everything-claude-code/rules/python/* ~/.claude/rules/
670-
cp -r everything-claude-code/rules/golang/* ~/.claude/rules/
671-
cp -r everything-claude-code/rules/php/* ~/.claude/rules/
666+
# Copy rules directories (common + language-specific)
667+
mkdir -p ~/.claude/rules
668+
cp -r everything-claude-code/rules/common ~/.claude/rules/
669+
cp -r everything-claude-code/rules/typescript ~/.claude/rules/ # pick your stack
670+
cp -r everything-claude-code/rules/python ~/.claude/rules/
671+
cp -r everything-claude-code/rules/golang ~/.claude/rules/
672+
cp -r everything-claude-code/rules/php ~/.claude/rules/
672673
673674
# Copy commands
674675
cp everything-claude-code/commands/*.md ~/.claude/commands/
@@ -874,7 +875,8 @@ Yes. Use Option 2 (manual installation) and copy only what you need:
874875
cp everything-claude-code/agents/*.md ~/.claude/agents/
875876
876877
# Just rules
877-
cp -r everything-claude-code/rules/common/* ~/.claude/rules/
878+
mkdir -p ~/.claude/rules/
879+
cp -r everything-claude-code/rules/common ~/.claude/rules/
878880
```
879881
880882
Each component is fully independent.

README.zh-CN.md

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,17 @@
8282
# 首先克隆仓库
8383
git clone https://github.com/affaan-m/everything-claude-code.git
8484

85-
# 复制规则(通用 + 语言特定)
86-
cp -r everything-claude-code/rules/common/* ~/.claude/rules/
87-
cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ # 选择你的技术栈
88-
cp -r everything-claude-code/rules/python/* ~/.claude/rules/
89-
cp -r everything-claude-code/rules/golang/* ~/.claude/rules/
90-
cp -r everything-claude-code/rules/perl/* ~/.claude/rules/
85+
# 复制规则目录(通用 + 语言特定)
86+
mkdir -p ~/.claude/rules
87+
cp -r everything-claude-code/rules/common ~/.claude/rules/
88+
cp -r everything-claude-code/rules/typescript ~/.claude/rules/ # 选择你的技术栈
89+
cp -r everything-claude-code/rules/python ~/.claude/rules/
90+
cp -r everything-claude-code/rules/golang ~/.claude/rules/
91+
cp -r everything-claude-code/rules/perl ~/.claude/rules/
9192
```
9293

94+
复制规则时,请复制整个目录(例如 `rules/common``rules/golang`),而不是复制目录内的文件;这样可以保留相对引用,并避免不同规则集中的同名文件互相覆盖。
95+
9396
### 第三步:开始使用
9497

9598
```bash
@@ -366,11 +369,20 @@ everything-claude-code/
366369
> git clone https://github.com/affaan-m/everything-claude-code.git
367370
>
368371
> # 选项 A:用户级规则(应用于所有项目)
369-
> cp -r everything-claude-code/rules/* ~/.claude/rules/
372+
> mkdir -p ~/.claude/rules
373+
> cp -r everything-claude-code/rules/common ~/.claude/rules/
374+
> cp -r everything-claude-code/rules/typescript ~/.claude/rules/
375+
> cp -r everything-claude-code/rules/python ~/.claude/rules/
376+
> cp -r everything-claude-code/rules/golang ~/.claude/rules/
377+
> cp -r everything-claude-code/rules/perl ~/.claude/rules/
370378
>
371379
> # 选项 B:项目级规则(仅应用于当前项目)
372380
> mkdir -p .claude/rules
373-
> cp -r everything-claude-code/rules/* .claude/rules/
381+
> cp -r everything-claude-code/rules/common .claude/rules/
382+
> cp -r everything-claude-code/rules/typescript .claude/rules/
383+
> cp -r everything-claude-code/rules/python .claude/rules/
384+
> cp -r everything-claude-code/rules/golang .claude/rules/
385+
> cp -r everything-claude-code/rules/perl .claude/rules/
374386
> ```
375387
376388
---
@@ -386,12 +398,13 @@ git clone https://github.com/affaan-m/everything-claude-code.git
386398
# 将代理复制到你的 Claude 配置
387399
cp everything-claude-code/agents/*.md ~/.claude/agents/
388400
389-
# 复制规则(通用 + 语言特定)
390-
cp -r everything-claude-code/rules/common/* ~/.claude/rules/
391-
cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ # 选择你的技术栈
392-
cp -r everything-claude-code/rules/python/* ~/.claude/rules/
393-
cp -r everything-claude-code/rules/golang/* ~/.claude/rules/
394-
cp -r everything-claude-code/rules/perl/* ~/.claude/rules/
401+
# 复制规则目录(通用 + 语言特定)
402+
mkdir -p ~/.claude/rules
403+
cp -r everything-claude-code/rules/common ~/.claude/rules/
404+
cp -r everything-claude-code/rules/typescript ~/.claude/rules/ # 选择你的技术栈
405+
cp -r everything-claude-code/rules/python ~/.claude/rules/
406+
cp -r everything-claude-code/rules/golang ~/.claude/rules/
407+
cp -r everything-claude-code/rules/perl ~/.claude/rules/
395408
396409
# 复制命令
397410
cp everything-claude-code/commands/*.md ~/.claude/commands/

0 commit comments

Comments
 (0)