Skip to content

Commit 1578dc0

Browse files
committed
docs: add note that project folder must be a Git repository
The `deepwork install` command requires a Git repository but this wasn't documented, causing confusion for users who try to install in non-Git folders.
1 parent 77402b2 commit 1578dc0

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,14 @@ Triage email, give feedback to your team, make tutorials/documentation, QA your
77
brew tap unsupervisedcom/deepwork && brew install deepwork
88
```
99

10-
Then in your project folder:
10+
Then in your project folder (must be a Git repository):
1111
```bash
1212
deepwork install
1313
claude
1414
```
1515

16+
> **Note:** DeepWork requires a Git repository. If your folder isn't already a repo, run `git init` first.
17+
1618
Now inside claude, define your first job using the `/deepwork_jobs` command. Ex.
1719
```
1820
/deepwork_jobs Make a job for doing competitive research. It will take the URL of the competitor as an input, and should make report including a SWOT analysis for that competitor.
@@ -81,12 +83,14 @@ brew tap unsupervisedcom/deepwork
8183
brew install deepwork
8284
```
8385

84-
Then in any project folder:
86+
Then in any project folder (must be a Git repository):
8587

8688
```bash
8789
deepwork install
8890
```
8991

92+
> **Note:** If your folder isn't a Git repo yet, run `git init` first.
93+
9094
**After install, load Claude.** Then verify you see this command: `/deepwork_jobs`
9195

9296
### 2. Define Your First Workflow

0 commit comments

Comments
 (0)