ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

readme correction

This commit is contained in:
Brian Madison 2025-06-16 20:31:27 -05:00
parent e2e1658c07
commit aa482b6454
1 changed files with 6 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -15,22 +15,16 @@
### Fastest Start: Web UI (2 minutes) 🏃‍♂️ ### Fastest Start: Web UI (2 minutes) 🏃‍♂️
1. Copy `.bmad-core/web-bundles/teams/team-fullstack.txt` 1. Copy `bmad-core/web-bundles/teams/team-fullstack.txt`
2. Create a new Gemini Gem or CustomGPT 2. Create a new Gemini Gem or CustomGPT
3. Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed" 3. Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
4. Start chatting! Type `/help` to see available commands 4. Start chatting! Type `/help` to see available commands
### IDE Quick Start (5 minutes) 💻 ### IDE Quick Start (5 minutes) 💻
**Prerequisites**: Install [Node.js](https://nodejs.org) (v14 or higher) **Prerequisites**: Install [Node.js](https://nodejs.org) (v20 or higher)
````bash Run `npx bmad-method install`
npx bmad-method install
# The installer will automatically detect your project state and guide you through:
# - Fresh installation or upgrade from v3
# - Full installation or single agent
# - Destination folder and IDE configuration
```text
This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically. This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically.
@ -70,23 +64,9 @@ For ChatGPT, Claude, or Gemini web interfaces:
### Method 2: CLI Installer (For IDEs) 🎯 ### Method 2: CLI Installer (For IDEs) 🎯
**Prerequisites**: Install [Node.js](https://nodejs.org) v14+ first **Prerequisites**: Install [Node.js](https://nodejs.org) v20+ first
Install directly into your project: Install directly into your project: `npx bmad-method install`
```bash
# Interactive installation (recommended)
npx bmad-method install
# The installer automatically detects your project state and guides you through:
# - Fresh installation or upgrade from v3
# - Installation type (full/single agent)
# - Destination directory
# - IDE configuration
# Or use command line options for fresh installations
npx bmad-method install --full --directory ./my-project --ide cursor
npx bmad-method install --agent pm --directory ./my-project --ide claude-code
````
**Supported IDEs:** **Supported IDEs:**
@ -96,7 +76,7 @@ The BMad Method works with any IDE, but has built-in integration for:
- `claude-code` - Claude Code with /agent commands - `claude-code` - Claude Code with /agent commands
- `windsurf` - Windsurf with @agent commands - `windsurf` - Windsurf with @agent commands
- `roo` - Roo Code with custom modes (see `.roomodes`) - `roo` - Roo Code with custom modes (see `.roomodes`)
- More coming soon - BUT ITS easy to use with ANY IDE! - More coming soon - BUT ITS easy to use with ANY IDE - just copy the bmad-code folder to your project, and rename it .bmad-code.
## Available Agents ## Available Agents