Skip to content

Commit 029293a

Browse files
committed
docs(quickstart): prioritize project-local usage and separate contributor clone path
1 parent 99a10bb commit 029293a

4 files changed

Lines changed: 40 additions & 13 deletions

File tree

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,21 +42,26 @@ Every task delegation includes THREE elements:
4242
## ⚡ Quick Start (60 Seconds)
4343

4444
```bash
45-
# 1. Setup
46-
git clone https://github.com/T72/task-orchestrator.git
47-
cd task-orchestrator
45+
# 1. In YOUR project root
46+
cd /path/to/your-project
47+
48+
# 2. Add tm from a release artifact or local install
49+
cp /path/to/task-orchestrator/tm ./tm
50+
chmod +x ./tm
51+
52+
# 3. Initialize Task Orchestrator in this project
4853
./tm init
4954

50-
# 2. Set agent identity (required for coordination)
55+
# 4. Set agent identity (required for coordination)
5156
export TM_AGENT_ID="orchestrator_agent"
5257

53-
# 3. Create AI Agent Workflow with Commander's Intent
58+
# 5. Create AI Agent Workflow with Commander's Intent
5459
BACKEND=$(./tm add "Build auth API" --assignee backend_agent \
5560
-d "WHY: Secure foundation, WHAT: OAuth2/JWT/sessions, DONE: Users can login safely" | grep -o '[a-f0-9]\{8\}')
5661

5762
FRONTEND=$(./tm add "Create login UI" --assignee frontend_agent --depends-on $BACKEND | grep -o '[a-f0-9]\{8\}')
5863

59-
# 4. Watch Real-Time Orchestration
64+
# 6. Watch Real-Time Orchestration
6065
./tm watch # See instant updates as agents work
6166

6267
# When backend completes, frontend auto-unblocks!
@@ -118,7 +123,15 @@ python3 docs/examples/multi_agent_workflow.py # Team coordination
118123
## 🚀 Installation
119124

120125
```bash
121-
# Requirements: Python 3.8+, 10MB disk space
126+
# Use in your own project
127+
cd /path/to/your-project
128+
cp /path/to/task-orchestrator/tm ./tm
129+
chmod +x ./tm
130+
./tm init
131+
```
132+
133+
```bash
134+
# Contributor path (develop task-orchestrator itself)
122135
git clone https://github.com/T72/task-orchestrator.git
123136
cd task-orchestrator
124137
./tm init

docs/guides/getting-started.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ Start orchestrating AI agents in under 5 minutes.
66

77
### Quick Install
88
```bash
9+
# In your own project root
10+
cd /your/project
11+
12+
# Add tm from release artifact or local install
13+
cp /path/to/task-orchestrator/tm ./tm
14+
chmod +x tm
15+
./tm init
16+
```
17+
18+
### Contributor Install (for developing task-orchestrator itself)
19+
```bash
920
git clone https://github.com/T72/task-orchestrator.git
1021
cd task-orchestrator
1122
chmod +x tm
@@ -109,4 +120,4 @@ Watch for task updates:
109120
| `./tm watch` | Monitor changes |
110121

111122
---
112-
*Getting started takes 5 minutes. Master orchestration in 30.*
123+
*Getting started takes 5 minutes. Master orchestration in 30.*

docs/guides/quickstart-claude-code.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
## 🚀 30-Second Setup
44

55
```bash
6-
# 1. Clone the repository
7-
git clone https://github.com/T72/task-orchestrator.git
8-
cd task-orchestrator
6+
# 1. Go to your project
7+
cd /your/project
98

10-
# 2. Make executable and initialize
9+
# 2. Add tm from release artifact or local install
10+
cp /path/to/task-orchestrator/tm ./tm
1111
chmod +x tm
1212
./tm init
1313

@@ -16,7 +16,7 @@ export TM_AGENT_ID="orchestrator_agent"
1616
./tm add "My first task"
1717
```
1818

19-
**That's it!** Task Orchestrator is now ready for use with Claude Code.
19+
**That's it!** Task Orchestrator is now ready in your project for use with Claude Code.
2020

2121
## 🤖 Claude Code Integration
2222

docs/guides/user-guide.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Welcome to Task Orchestrator - the tool that transforms meta-agents into orchestration engines.
44

5+
> Use Task Orchestrator inside your own project repository.
6+
> Cloning `T72/task-orchestrator` is only required when contributing to Task Orchestrator itself.
7+
58
## 📚 Documentation Structure
69

710
### Quick Navigation

0 commit comments

Comments
 (0)