Skip to content

docs: add note that project folder must be a Git repository #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ncrmro merged 1 commit into from
Feb 3, 2026
Merged

docs: add note that project folder must be a Git repository #199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ Triage email, give feedback to your team, make tutorials/documentation, QA your
brew tap unsupervisedcom/deepwork && brew install deepwork
```

Then in your project folder:
Then in your project folder (must be a Git repository):
```bash
deepwork install
claude
```

> **Note:** DeepWork requires a Git repository. If your folder isn't already a repo, run `git init` first.

Now inside claude, define your first job using the `/deepwork_jobs` command. Ex.
```
/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.
Expand Down Expand Up @@ -81,12 +83,14 @@ brew tap unsupervisedcom/deepwork
brew install deepwork
```

Then in any project folder:
Then in any project folder (must be a Git repository):

```bash
deepwork install
```

> **Note:** If your folder isn't a Git repo yet, run `git init` first.

**After install, load Claude.** Then verify you see this command: `/deepwork_jobs`

### 2. Define Your First Workflow
Expand Down