Skip to content

Commit c34ad45

Browse files
committed
docs: update installation instructions and directory structure to reflect the migration of rules to GEMINI.md templates
1 parent bf76eb9 commit c34ad45

4 files changed

Lines changed: 21 additions & 22 deletions

File tree

README.ko.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,12 @@ cp everything-gemini-code/workflows/*.md ~/.gemini/antigravity/global_workflows/
8989
# 스킬 복사
9090
cp -r everything-gemini-code/skills/* ~/.gemini/skills/
9191

92-
# 규칙 설치 (두 설치 방법 모두 필수)
93-
cp -r everything-gemini-code/rules/common/* ~/.gemini/rules/
9492
```
9593

9694
> **Antigravity 사용자 참고:**
97-
> Antigravity를 위해 수동 설치하는 경우, 호환성을 위해 `~/.gemini/antigravity/` 하위 디렉토리(`global_agents`, `global_skills`, `global_rules`)에 복사하는 것이 좋습니다. `install.sh` 스크립트는 이를 자동으로 처리합니다.
95+
> Antigravity를 위해 수동 설치하는 경우, 호환성을 위해 `~/.gemini/antigravity/` 하위 디렉토리(`global_agents`, `global_skills`)에 복사하는 것이 좋습니다. `install.sh` 스크립트는 이를 자동으로 처리합니다.
96+
>
97+
> **참고:** 규칙은 `install.sh`를 통해 `~/.gemini/GEMINI.md`에 통합됩니다. 수동 설치 시: `cp everything-gemini-code/templates/GEMINI_GLOBAL.md ~/.gemini/GEMINI.md`
9898
9999
### 옵션 3: Gemini CLI 확장 프로그램으로 설치 (개발자 모드)
100100

@@ -165,7 +165,7 @@ everything-gemini-code/
165165
├── skills/ # 워크플로우 정의 (TDD, 패턴 등)
166166
├── commands/ # Gemini CLI 명령어 (.toml)
167167
├── workflows/ # Antigravity 워크플로우 (.md)
168-
├── rules/ # 코딩 가이드라인 (TypeScript, Python, Go)
168+
├── templates/ # GEMINI.md 규칙 템플릿 (Global, TS, Python, Go)
169169
├── hooks/ # 자동화 트리거 (hooks.json)
170170
└── mcp-configs/ # MCP 서버 설정
171171
```

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,12 @@ cp everything-gemini-code/workflows/*.md ~/.gemini/antigravity/global_workflows/
9191
# Copy skills
9292
cp -r everything-gemini-code/skills/* ~/.gemini/skills/
9393

94-
# Install rules (Required for both installation methods)
95-
cp -r everything-gemini-code/rules/common/* ~/.gemini/rules/
9694
```
9795

9896
> **For Antigravity Users:**
99-
> If you are manually installing for Antigravity, copying to `~/.gemini/antigravity/` subdirectories (`global_agents`, `global_skills`, `global_rules`) is recommended for full compatibility. The `install.sh` script handles this automatically.
97+
> If you are manually installing for Antigravity, copying to `~/.gemini/antigravity/` subdirectories (`global_agents`, `global_skills`) is recommended for full compatibility. The `install.sh` script handles this automatically.
98+
>
99+
> **Note:** Rules are bundled into `~/.gemini/GEMINI.md` via `install.sh`. For manual installs, copy a template: `cp everything-gemini-code/templates/GEMINI_GLOBAL.md ~/.gemini/GEMINI.md`
100100
101101
````
102102
@@ -113,7 +113,7 @@ cd everything-gemini-code
113113
gemini extensions link .
114114
````
115115

116-
> ⚠️ **Note:** Rules still need to be installed manually to `~/.gemini/rules/` or `~/.gemini/antigravity/global_rules/` as extensions do not automatically distribute them.
116+
> ⚠️ **Note:** Rules are generated into `~/.gemini/GEMINI.md` by the install script. For extension-only installs, copy a template manually: `cp templates/GEMINI_GLOBAL.md ~/.gemini/GEMINI.md`
117117
118118
---
119119

@@ -169,7 +169,7 @@ everything-gemini-code/
169169
├── skills/ # Workflow definitions (TDD, Patterns, etc.)
170170
├── commands/ # Gemini CLI commands (.toml)
171171
├── workflows/ # Antigravity workflows (.md)
172-
├── rules/ # Coding guidelines (TypeScript, Python, Go)
172+
├── templates/ # GEMINI.md rule templates (Global, TS, Python, Go)
173173
├── hooks/ # Automation triggers (hooks.json)
174174
└── mcp-configs/ # MCP server configurations
175175
```

README.zh-CN.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,9 @@ cp everything-gemini-code/commands/*.md ~/.gemini/commands/
3737
# 复制 Skills
3838
cp -r everything-gemini-code/skills/* ~/.gemini/skills/
3939

40-
# 安装 Rules(两种安装方式均必需)
41-
cp -r everything-gemini-code/rules/common/* ~/.gemini/rules/
4240
```
4341

44-
> ⚠️ **注意:** Rules(规则)无法通过扩展自动分发,必须手动安装到 `~/.gemini/rules/` 目录。
42+
> ⚠️ **注意:** 规则通过 `install.sh` 生成到 `~/.gemini/GEMINI.md`。手动安装时:`cp everything-gemini-code/templates/GEMINI_GLOBAL.md ~/.gemini/GEMINI.md`
4543
4644
### 选项 1:卸载(推荐)
4745

@@ -112,7 +110,7 @@ everything-gemini-code/
112110
├── agents/ # 专用子智能体 (@planner, @architect 等)
113111
├── skills/ # 工作流定义 (TDD, Patterns 等)
114112
├── commands/ # 斜杠命令 (/plan, /tdd 等)
115-
├── rules/ # 编码指南 (TypeScript, Python, Go)
113+
├── templates/ # GEMINI.md 规则模板 (Global, TS, Python, Go)
116114
├── hooks/ # 自动化触发器 (hooks.json)
117115
└── mcp-configs/ # MCP 服务器配置
118116
```

docs/ko-KR/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -151,11 +151,11 @@ everything-gemini-code/
151151
152152
├── workflows/ # Antigravity 워크플로우 (.md)
153153
154-
├── rules/ # 코딩 가이드라인
155-
│ ├── common/ # 언어 무관 원칙
156-
│ ├── typescript/ # TypeScript/JavaScript 전용
157-
│ ├── python/ # Python 전용
158-
│ └── golang/ # Go 전용
154+
├── templates/ # GEMINI.md 규칙 템플릿
155+
│ ├── GEMINI_GLOBAL.md # 공통 규칙
156+
│ ├── GEMINI_TS.md # TypeScript/JavaScript 전용
157+
│ ├── GEMINI_PYTHON.md # Python 전용
158+
│ └── GEMINI_GO.md # Go 전용
159159
160160
├── hooks/ # 자동화 트리거 (hooks.json)
161161
@@ -193,13 +193,14 @@ cp everything-gemini-code/commands/*.toml ~/.gemini/commands/
193193
# 스킬 복사
194194
cp -r everything-gemini-code/skills/* ~/.gemini/skills/
195195

196-
# 룰 복사 (공통 + 언어별)
197-
cp -r everything-gemini-code/rules/common/* ~/.gemini/rules/
198-
cp -r everything-gemini-code/rules/typescript/* ~/.gemini/rules/ # 사용하는 스택 선택
199196
```
200197

198+
> **규칙 설치:** 규칙은 `install.sh`를 통해 `~/.gemini/GEMINI.md`에 통합됩니다.
199+
> 수동 설치 시: `cp everything-gemini-code/templates/GEMINI_GLOBAL.md ~/.gemini/GEMINI.md`
200+
> TypeScript 규칙 추가: `cat everything-gemini-code/templates/GEMINI_TS.md >> ~/.gemini/GEMINI.md`
201+
>
201202
> **Antigravity 사용자:**
202-
> Antigravity용으로 수동 설치 시 `~/.gemini/antigravity/` 하위 디렉토리(`global_agents`, `global_skills`, `global_rules`)에 복사하는 것을 권장합니다. `install.sh` 스크립트가 이를 자동으로 처리합니다.
203+
> Antigravity용으로 수동 설치 시 `~/.gemini/antigravity/` 하위 디렉토리(`global_agents`, `global_skills`)에 복사하는 것을 권장합니다. `install.sh` 스크립트가 이를 자동으로 처리합니다.
203204
204205
---
205206

0 commit comments

Comments
 (0)