Skip to content

Commit ba897c9

Browse files
authored
Merge pull request #9 from squareup/readme-prerequisites
Add Claude Code as prerequisite, auto-install Go
2 parents ada2813 + 10b17d4 commit ba897c9

2 files changed

Lines changed: 19 additions & 11 deletions

File tree

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,19 @@ A local web app that **only** operates on markdown files inside `thoughts/` dire
2020

2121
### Prerequisites
2222

23-
1. **Go 1.21+** - Required to build and run the server
24-
```bash
25-
# On macOS with Homebrew
26-
brew install go
27-
28-
# Or download from https://go.dev/dl/
29-
```
30-
31-
2. **just** - Command runner for development tasks
23+
1. **just** - Command runner for development tasks (the only manual install)
3224
```bash
3325
# On macOS with Homebrew
3426
brew install just
3527

3628
# Or see https://github.com/casey/just for other platforms
3729
```
3830

39-
3. **fswatch** (optional) - For hot reload in dev mode (auto-installed via brew on macOS)
31+
The remaining dependencies are auto-installed when you run `just run` or `just dev`:
32+
33+
2. **Claude Code** - Birdseye is designed to work with Claude Code agents for collaborative document review (see [go/claude-code](https://go/claude-code) for setup details)
34+
3. **Go 1.21+** - Required to build and run the server
35+
4. **fswatch** (optional) - For hot reload in dev mode, installed automatically by `just dev`
4036

4137
## Usage
4238

justfile

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,21 @@
22
default: run
33

44
# Build the binary
5-
build:
5+
build: ensure-deps
66
go build -o birdseye .
77

8+
# Ensure required tools are installed
9+
ensure-deps:
10+
#!/usr/bin/env bash
11+
if ! command -v go &> /dev/null; then
12+
echo "Installing Go..."
13+
brew install go
14+
fi
15+
if ! command -v claude &> /dev/null; then
16+
echo "Installing Claude Code..."
17+
brew install claude-code
18+
fi
19+
820
# Run the server and open browser
921
run: build
1022
#!/usr/bin/env bash

0 commit comments

Comments
 (0)