From 22cdd17f00e515c87e4effaa659eff76808e3cdc Mon Sep 17 00:00:00 2001 From: Alex Alaniz Date: Thu, 22 Jan 2026 22:35:59 -0500 Subject: [PATCH] docs: clarify setup instructions as distinct approaches Reword 'Option 1/Option 2' to 'Approach A/Approach B' to clarify these are alternative setup strategies, not sequential steps. - Approach A: Project-local (recommended for teams) - Approach B: Global (for personal use) Fixes #19 --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4db35bc2..1ca8fffb 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,11 @@ Based on [Geoffrey Huntley's Ralph pattern](https://ghuntley.com/ralph/). ## Setup -### Option 1: Copy to your project +Choose **one** of the following approaches: -Copy the ralph files into your project: +### Approach A: Project-local setup (recommended for teams) + +Keep everything in your project repository so teammates get Ralph automatically: ```bash # From your project root @@ -33,24 +35,31 @@ cp /path/to/ralph/prompt.md scripts/ralph/prompt.md # For Amp cp /path/to/ralph/CLAUDE.md scripts/ralph/CLAUDE.md # For Claude Code chmod +x scripts/ralph/ralph.sh + +# Also copy the skills to your project +cp -r /path/to/ralph/skills .claude/skills/ # For Claude Code +# OR +cp -r /path/to/ralph/skills .amp/skills/ # For Amp ``` -### Option 2: Install skills globally +### Approach B: Global setup (for personal use across projects) -Copy the skills to your Amp or Claude config for use across all projects: +Install skills globally so they're available in any project: -For AMP +**For Amp:** ```bash cp -r skills/prd ~/.config/amp/skills/ cp -r skills/ralph ~/.config/amp/skills/ ``` -For Claude Code +**For Claude Code:** ```bash cp -r skills/prd ~/.claude/skills/ cp -r skills/ralph ~/.claude/skills/ ``` +Then copy `ralph.sh` and the prompt template to each project as needed. + ### Configure Amp auto-handoff (recommended) Add to `~/.config/amp/settings.json`: