Compare commits
3 Commits
8fbceba434
...
6a2e652081
| Author | SHA1 | Date |
|---|---|---|
|
|
6a2e652081 | |
|
|
c9f2dc51db | |
|
|
7c6ae48999 |
35
README.md
35
README.md
|
|
@ -26,27 +26,34 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
|
||||||
npx bmad-method@alpha install
|
npx bmad-method@alpha install
|
||||||
```
|
```
|
||||||
|
|
||||||
Follow the installer prompts to configure your project. Then run:
|
Follow the installer prompts to configure your project.
|
||||||
|
|
||||||
```bash
|
Once you have installed BMad to a folder, launch your tool of choice from where you installed BMad. (We really like Claude Code and Cursor - but there are any that work great with BMad!)
|
||||||
*workflow-init
|
|
||||||
```
|
Then its simple as running the command: `/bmad-help` if you do not know what to do. Depending on which modules you have installed, you will have different choices.
|
||||||
|
|
||||||
|
To make the help more applicable you can even run the `/bmad-help What do you suggest I do to get started building a brand new web application for XYZ`.
|
||||||
|
|
||||||
|
The results from BMad Help will be able to suggest and constantly guide you on what to do next - along with the workflows upon completion also making suggestions on what to do next.
|
||||||
|
|
||||||
This analyzes your project and recommends a track:
|
This analyzes your project and recommends a track:
|
||||||
|
|
||||||
| Track | Best For | Time to First Story |
|
| Track | Best For | Time to First Story Coding |
|
||||||
| --------------- | ------------------------- | ------------------- |
|
| --------------- | ------------------------- | -------------------------- |
|
||||||
| **Quick Flow** | Bug fixes, small features | ~5 minutes |
|
| **Quick Flow** | Bug fixes, small features | ~10-30 minutes |
|
||||||
| **BMad Method** | Products and platforms | ~15 minutes |
|
| **BMad Method** | Products and platforms | ~30 minutes - 2 hours |
|
||||||
| **Enterprise** | Compliance-heavy systems | ~30 minutes |
|
| **Enterprise** | Compliance-heavy systems | ~1-3 hours |
|
||||||
|
|
||||||
## Modules
|
## Modules
|
||||||
|
|
||||||
| Module | Purpose |
|
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time.
|
||||||
| ------------------------------------- | -------------------------------------------------------- |
|
|
||||||
| **BMad Method (BMM)** | Core agile development with 34 workflows across 4 phases |
|
| Module | GitHub | NPM | Purpose |
|
||||||
| **BMad Builder (BMB)** | Create custom agents and domain-specific modules |
|
|--------|--------|-----|---------|
|
||||||
| **Creative Intelligence Suite (CIS)** | Innovation, brainstorming, and problem-solving |
|
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
|
||||||
|
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
|
||||||
|
| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot |
|
||||||
|
| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving |
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
name: 'step-01-understand'
|
name: 'step-01-understand'
|
||||||
description: 'Analyze the requirement delta between current state and what user wants to build'
|
description: 'Analyze the requirement delta between current state and what user wants to build'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec'
|
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
|
||||||
nextStepFile: './step-02-investigate.md'
|
nextStepFile: './step-02-investigate.md'
|
||||||
skipToStepFile: './step-03-generate.md'
|
skipToStepFile: './step-03-generate.md'
|
||||||
templateFile: '{workflow_path}/tech-spec-template.md'
|
templateFile: '{workflow_path}/tech-spec-template.md'
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
name: 'step-02-investigate'
|
name: 'step-02-investigate'
|
||||||
description: 'Map technical constraints and anchor points within the codebase'
|
description: 'Map technical constraints and anchor points within the codebase'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec'
|
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
|
||||||
nextStepFile: './step-03-generate.md'
|
nextStepFile: './step-03-generate.md'
|
||||||
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
name: 'step-03-generate'
|
name: 'step-03-generate'
|
||||||
description: 'Build the implementation plan based on the technical mapping of constraints'
|
description: 'Build the implementation plan based on the technical mapping of constraints'
|
||||||
|
|
||||||
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec'
|
workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec'
|
||||||
nextStepFile: './step-04-review.md'
|
nextStepFile: './step-04-review.md'
|
||||||
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
||||||
---
|
---
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue