Skip to content

Commit b0a4458

Browse files
committed
docs(readme): align multilingual README guidance
Use the current zh-CN README as the source structure and sync English, Japanese, Korean, and Hindi variants. Update installation, runtime storage, update workflow, platform support, and troubleshooting sections consistently across the localized READMEs.
1 parent 6ecc2fa commit b0a4458

5 files changed

Lines changed: 206 additions & 154 deletions

File tree

RPG-Kit/README.hi-IN.md

Lines changed: 45 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ MCP Server: search_rpg / explore_rpg / get_node_detail / list_rpg_tree
7979

8080
### RPG-Kit वास्तविक उपयोग में
8181

82-
नीचे दी गई छवि इस रिपॉज़िटरी के लिए जनरेट किए गए ग्राफ़ विज़ुअलाइज़ेशन का एक भाग है। `/rpgkit.encode` चलाएँ और पूर्ण इंटरैक्टिव ग्राफ़ देखने के लिए `.rpgkit/data/rpg.html` खोलें।
82+
नीचे दी गई छवि इस रिपॉज़िटरी के लिए जनरेट किए गए ग्राफ़ विज़ुअलाइज़ेशन का एक भाग है। `/rpgkit.encode` चलाने के बाद, पूर्ण इंटरैक्टिव ग्राफ़ देखने के लिए `<workspace>/.rpgkit/reports/rpg.html` खोलें। वर्तमान वर्कस्पेस के हल किए गए पथ देखने के लिए `rpgkit version` चलाएँ
8383

8484
![RPG-Kit repository graph visualization](../docs/rpgkit_visualized_graph.png)
8585

@@ -103,6 +103,8 @@ rpgkit check
103103
uvx --from "git+https://github.com/microsoft/RPG-ZeroRepo.git#subdirectory=RPG-Kit" rpgkit init <project-name>
104104
```
105105

106+
`0.1.3` से, wheel pipeline scripts और slash-command templates को packaged assets के रूप में शामिल करता है, इसलिए `rpgkit init` ऑफ़लाइन वातावरणों (जैसे air-gapped या corporate proxy वातावरण) में भी काम करता है।
107+
106108
## Quick Start: नई रिपॉज़िटरी
107109

108110
जब आप RPG-Kit से आवश्यकताओं को एक नए कोडबेस में बदलवाना चाहते हैं, तब इस मार्ग का उपयोग करें।
@@ -122,7 +124,6 @@ uvx --from "git+https://github.com/microsoft/RPG-ZeroRepo.git#subdirectory=RPG-K
122124
```bash
123125
rpgkit init my-project --ai claude --script sh
124126
rpgkit init my-project --ai copilot
125-
rpgkit init my-project --github-token $GITHUB_TOKEN
126127
```
127128

128129
2. **[वैकल्पिक]** अपने आवश्यकता दस्तावेज़ `my-project/docs/` में रखें।
@@ -145,7 +146,13 @@ uvx --from "git+https://github.com/microsoft/RPG-ZeroRepo.git#subdirectory=RPG-K
145146
[Optional] /rpgkit.rpg_edit <edit instructions>
146147
```
147148

148-
RPG-Kit क्रमिक रूप से `.rpgkit/data/rpg.json` बनाता है और इसका उपयोग आवश्यकताओं, प्लानिंग आउटपुट, जनरेटेड कोड और dependency जानकारी को संरेखित रखने के लिए करता है।
149+
> [!IMPORTANT]
150+
> **हर Coding Agent का इनवोकेशन थोड़ा अलग होता है**:
151+
>
152+
> - **Claude Code**: चैट में सीधे `/rpgkit.feature_spec ...` टाइप करें — slash command पहचाने जाते हैं और संबंधित workflow ट्रिगर हो जाता है।
153+
> - **GitHub Copilot CLI**: slash command समर्थित नहीं हैं (कस्टम agent समर्थित हैं), इसलिए पहले `/agent rpgkit.feature_spec` से लक्ष्य agent पर स्विच करें, फिर `start` टाइप करके इसका अंतर्निहित workflow चलाएँ।
154+
155+
RPG-Kit क्रमिक रूप से `~/.rpgkit/workspaces/<hash>/data/rpg.json` बनाता है और इसका उपयोग आवश्यकताओं, प्लानिंग आउटपुट, जनरेटेड कोड और dependency जानकारी को संरेखित रखने के लिए करता है। आपके वर्कस्पेस की स्रोत फ़ाइलें दूषित नहीं होंगी।
149156

150157
## Quick Start: मौजूदा रिपॉज़िटरी
151158

@@ -157,10 +164,8 @@ RPG-Kit क्रमिक रूप से `.rpgkit/data/rpg.json` बनात
157164
1. रिपॉज़िटरी रूट में RPG-Kit को आरंभीकृत करें और प्रारंभिक ग्राफ़ बनाएँ:
158165

159166
```bash
160-
mkdir my-project
161-
cp -r existing-repo/ my-project/
162-
cd my-project
163-
rpgkit init . --encode
167+
cd existing-repo/
168+
rpgkit init . --encode # --encode वर्तमान कोड से RPG उत्पन्न करता है
164169
```
165170

166171
यदि आप गैर-खाली निर्देशिका के लिए पुष्टि संकेत को छोड़ना चाहते हैं:
@@ -171,45 +176,61 @@ RPG-Kit क्रमिक रूप से `.rpgkit/data/rpg.json` बनात
171176

172177
2. रिपॉज़िटरी में अपना AI कोडिंग एजेंट लॉन्च करें।
173178

174-
3. MCP टूल्स और स्लैश कमांड्स के माध्यम से जनरेटेड RPG का उपयोग करें:
179+
3. **[वैकल्पिक]** MCP टूल्स और स्लैश कमांड्स के माध्यम से जनरेटेड RPG का उपयोग करें। नीचे दिए गए कमांड केवल मैन्युअल रूप से चलाने पर आवश्यक हैं:
175180

176181
```text
177182
/rpgkit.encode # आवश्यकता पड़ने पर पूर्ण RPG को पुनर्निर्मित करें
178183
/rpgkit.update_rpg # मैन्युअल वृद्धिशील अपडेट (fallback)
179184
/rpgkit.rpg_edit <edit instructions> # ग्राफ़-जागरूक कोड संपादन
180185
```
181186

182-
4. कमिट के बाद, RPG-Kit hooks `.rpgkit/data/rpg.json`, `.rpgkit/data/dep_graph.json` और `.rpgkit/data/rpg.html` को कोड परिवर्तनों के साथ संरेखित रखते हैं। यदि hook विफल हो जाता है या छोड़ दिया जाता है, तो `/rpgkit.update_rpg` चलाएँ।
187+
4. हर commit के बाद, RPG-Kit द्वारा इंस्टॉल किया गया git hook स्वचालित रूप से `rpgkit hook <name>` dispatcher को कॉल करता है, RPG को अपडेट करता है और उसे कोड परिवर्तनों के साथ संरेखित रखता है। यदि hook विफल हो जाता है या छोड़ दिया जाता है, तो `/rpgkit.update_rpg` मैन्युअल रूप से चलाएँ।
183188

184189
## `rpgkit init` के बाद क्या होता है
185190

186-
`rpgkit init` आपकी स्रोत फ़ाइलों को संशोधित नहीं करता है। यह आपके कोड के साथ-साथ कमांड परिभाषाएँ, रनटाइम स्क्रिप्ट्स, MCP कॉन्फ़िगरेशन और जनरेटेड ग्राफ़ डेटा जोड़ता है।
191+
`rpgkit init` आपकी स्रोत फ़ाइलों को संशोधित नहीं करता है, **और आपके वर्कस्पेस में रनटाइम स्टेट नहीं लिखता है**। यह आपके वर्कस्पेस में केवल command definitions, MCP कॉन्फ़िगरेशन और hooks जोड़ता है। RPG-Kit का रनटाइम डेटा (outputs और logs) home-side निर्देशिका `~/.rpgkit/workspaces/<hash>/` के अंतर्गत रखा जाता है, जो वर्कस्पेस के absolute path से जनित hash द्वारा अलग किया जाता है।
187192

188193
```text
189194
my-project/
190195
├── docs/ # /rpgkit.feature_spec के लिए वैकल्पिक आवश्यकता दस्तावेज़
191-
├── .github/ or .claude/ # AI सहायक कमांड परिभाषाएँ और सेटिंग्स
196+
├── .github/ or .claude/ # Coding Agent कमांड परिभाषाएँ और सेटिंग्स
192197
├── .vscode/ # लागू होने पर Copilot/VS Code MCP कॉन्फ़िगरेशन
193-
└── .rpgkit/ # RPG-Kit रनटाइम
194-
├── scripts/ # पाइपलाइन स्क्रिप्ट्स और सहायक पैकेज
195-
├── data/ # जनरेटेड आउटपुट, जिसमें rpg.json और dep_graph.json शामिल हैं
196-
├── logs/ # प्रति-चरण निष्पादन लॉग
197-
└── reports/ # जनरेट होने पर समीक्षा और निदान रिपोर्ट
198+
├── .rpgkit/ # जनरेटेड रिपोर्ट और कॉन्फ़िगरेशन फ़ाइलें
199+
└── .git/hooks/ # rpgkit init द्वारा इंस्टॉल किए गए post-commit / post-merge (प्रत्येक hook केवल एक पंक्ति: `rpgkit hook <name>`)
198200
```
199201

200202
पूर्ण लेआउट और डेटा फ़ाइल संदर्भ के लिए [docs/project-structure.md](docs/project-structure.md) देखें।
201203

204+
## RPG-Kit अपडेट करें
205+
206+
```bash
207+
uv tool install rpgkit-cli \
208+
--from "git+https://github.com/microsoft/RPG-ZeroRepo.git#subdirectory=RPG-Kit" \
209+
--force \
210+
--reinstall
211+
212+
# किसी मौजूदा वर्कस्पेस को अपडेट करें
213+
cd <your-workspace>
214+
rpgkit update
215+
```
216+
202217
## समर्थित प्लेटफ़ॉर्म्स
203218

204-
| प्लेटफ़ॉर्म | Claude Code | GitHub Copilot | Codex |
205-
| ------------------------ | ----------- | -------------- | ----- |
206-
| CLI उपयोग || ✅ (No MCP) ||
207-
| VS Code एक्सटेंशन उपयोग ||||
219+
**Coding Agent समर्थन**:
220+
221+
| Agent | CLI उपयोग | VS Code एक्सटेंशन उपयोग |
222+
| -------------- | --------- | ----------------------- |
223+
| Claude Code |||
224+
| GitHub Copilot |||
225+
| Codex |||
226+
227+
**ऑपरेटिंग सिस्टम समर्थन**:
208228

209-
| स्क्रिप्ट | Linux | Windows | Mac |
210-
| --------- | ----- | ------- | --- |
211-
| sh ||||
212-
| ps | N/A |||
229+
| ऑपरेटिंग सिस्टम | स्थिति |
230+
| ---------------- | ------ |
231+
| Linux ||
232+
| macOS ||
233+
| Windows ||
213234

214235
## दस्तावेज़ीकरण
215236

@@ -228,12 +249,6 @@ my-project/
228249

229250
**AI सहायक CLI नहीं मिला:** `rpgkit check` चलाएँ, चयनित सहायक CLI को इंस्टॉल और प्रमाणित करें, फिर `rpgkit init` या `rpgkit update` पुनः चलाएँ।
230251

231-
**MCP टूल्स `rpg_unavailable` की रिपोर्ट करते हैं:** `.rpgkit/data/rpg.json` बनाने के लिए `/rpgkit.encode` चलाएँ।
232-
233-
**वृद्धिशील अपडेट विफल:** `.rpgkit/logs/update_rpg.log` की जाँच करें, फिर `/rpgkit.update_rpg` चलाएँ।
234-
235-
**रेट लिमिट्स या निजी रिपॉज़िटरी एक्सेस के कारण टेम्पलेट डाउनलोड विफल:** `--github-token $GITHUB_TOKEN` पास करें या `GH_TOKEN` / `GITHUB_TOKEN` सेट करें।
236-
237252
## लाइसेंस
238253

239254
MIT License — विवरण के लिए [LICENSE](LICENSE) देखें।

0 commit comments

Comments
 (0)