Skip to content

Commit 4471a8c

Browse files
committed
Improve persona setup and README clarity
- Enhanced README setup instructions with clearer Quick Start emphasis - Added Gemini to editor config section in Minimal Setup - Clarified Standalone Agent as manual process - Updated persona setup workflow with enforcing warning rules - Added optional personality change prompt for predefined personas - Improved warning display for Antagonistic/Chaotic personalities
1 parent 7bdff33 commit 4471a8c

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,25 +42,29 @@ Watch how the Interactive Coding Agent works:
4242
## Setup
4343

4444
### Quick Start (Recommended)
45-
**Copy this `interactive-coding-agent` folder's contents** (the AGENTS.md file, rules/ folder, and others) **into your project root.** That's it! You now have interactive coding agents.
45+
**🚀 Easiest and fastest setup - works with all supported coding agents!**
46+
47+
**Copy this `interactive-coding-agent` folder's contents** (the AGENTS.md file, rules/ folder, and others) **into your project root.** That's it! You now have interactive coding agents configured for all platforms.
4648

4749
### Minimal Setup
4850
Want just the essentials? Copy these:
4951

5052
**Required Files and Folders:**
51-
- `AGENTS.md` (put in your project root)
5253
- `rules/` folder (the main rules)
5354
- `specs/` folder (for user persona and other specs)
54-
- `project-specs/` folder (for project specifications)
55+
- `feature-specs/` folder (for project specifications)
5556

5657
**Your Editor Config:**
5758
- **Trae AI**: Copy `.trae/` folder
5859
- **Cursor**: Copy `.cursor/` folder
5960
- **Windsurf**: Copy `.windsurf/` folder
6061
- **Kiro**: Copy `.kiro/` folder
62+
- **Gemini**: Copy `GEMINI.md` file
6163

6264
### Standalone Agent
63-
For those who prefer a single, self-contained set of rules, the `standalone-agent.rules.md` file offers a streamlined setup. Instead of copying multiple folders, you can use this single file.
65+
**⚙️ Manual setup flow** - For those who prefer a single, self-contained set of rules, the `standalone-agent.rules.md` file offers a streamlined setup. Instead of copying multiple folders, you can use this single file.
66+
67+
**This requires manual configuration following the instructions below:**
6468

6569
**Setup Instructions:**
6670
1. Download the `standalone-agent.rules.md` file from this repository.
@@ -188,7 +192,7 @@ The persona system ensures you get exactly the right level of detail and communi
188192
**Problem**: The agent is not creating specs for major decisions, or references are incorrect.
189193

190194
* **Check the Rules:** Ask the agent to "read `spec-management.rules.md`" to re-familiarize itself with the mandatory workflow.
191-
* **Verify the Index:** Ensure that `project-specs/index.json` is not corrupted and that all recent specs are correctly listed.
195+
* **Verify the Index:** Ensure that `feature-specs/index.json` is not corrupted and that all recent specs are correctly listed.
192196
* **Force a Sync:** If you suspect a mismatch, ask the agent to "verify and synchronize the spec index with the spec files."
193197

194198
---

rules/user-persona.rules.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,21 @@ After getting the nickname, you MUST offer the user a choice of predefined perso
2929
* If a predefined persona is chosen:
3030
1. Copy the selected file to `specs/user-persona.spec.md`.
3131
2. **Overwrite the Nickname** in the newly created file with the one provided in Step 1.
32-
* If `"Custom"` is chosen, proceed to Step 3.
32+
3. **Ask for Personality Change:** `"Would you like to change the coding agent personality? (y/n)"`
33+
4. **If Yes:**
34+
* Present the AI Personality options: `[Professional | Casual | Playful | Goofy | Antagonistic | Chaotic]`
35+
* Show a short description for each personality
36+
* **MANDATORY:** Display warning indicators (⚠️) and warning text for Antagonistic and Chaotic personalities
37+
* Update the `AI Personality` field in `specs/user-persona.spec.md` with their selection
38+
5. **If No:** Proceed with the current personality setting from the predefined persona
39+
* If `"Custom"` is chosen, proceed to Step 3: Interactive Persona Creation.
3340

3441
### Step 3: Interactive Persona Creation
3542
If the user opts for a custom persona, you MUST use the `rules/templates/persona.template.md` to create the `specs/user-persona.spec.md` file. You MUST ask the following questions interactively and populate the template with the answers:
3643

3744
1. **Role:** `"What is your primary role (e.g., Engineer, Designer, etc.)?"`
3845
2. **Experience Level:** `"Please choose your experience level: [Beginner | Intermediate | Senior | Expert]"`
39-
3. **AI Personality:** `"Please choose your desired AI personality: [Professional | Casual | Playful | Goofy | Antagonistic | Chaotic]"`. Show the description for each personality. (If no selection is made, `Professional` is the default.)
46+
3. **AI Personality:** `"Please choose your desired AI personality: [Professional | Casual | Playful | Goofy | Antagonistic | Chaotic]"`. Show the description for each personality. **MANDATORY:** Display warning indicators (⚠️) and warning text for Antagonistic and Chaotic personalities. (If no selection is made, `Professional` is the default.)
4047

4148
Upon completion, save the answers (including the nickname from Step 1) to `specs/user-persona.spec.md`.
4249

0 commit comments

Comments
 (0)