Skip to content

The open-source AI voice studio. Clone, dictate, create.

docs: add just commands to README dev quick start

James Pine411e91bb19b9
diff --git a/README.md b/README.md
index f0ea11f8..3383e3c4 100644
--- a/README.md
+++ b/README.md
@@ -225,42 +225,21 @@ Voicebox aims to be the **one-stop shop for everything voice** — cloning, synt
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed setup and contribution guidelines.
-**Using the Makefile (recommended):** Run `make help` to see all available commands for setup, development, building, and testing.
-
### Quick Start
-**With Makefile (Unix/macOS/Linux):**
-
```bash
-# Clone the repo
git clone https://github.com/jamiepine/voicebox.git
cd voicebox
-# Setup everything
-make setup
-
-# Start development
-make dev
+just setup # creates Python venv, installs all deps
+just dev # starts backend + desktop app
```
-**Manual setup (all platforms):**
-
-```bash
-# Clone the repo
-git clone https://github.com/jamiepine/voicebox.git
-cd voicebox
-
-# Install dependencies
-bun install
+Install [just](https://github.com/casey/just): `brew install just` or `cargo install just`. Run `just --list` to see all commands.
-# Install Python dependencies
-cd backend && pip install -r requirements.txt && cd ..
-
-# Start development
-bun run dev
-```
+Also available via Makefile: `make setup && make dev` (run `make help` for all commands).
-**Prerequisites:** [Bun](https://bun.sh), [Rust](https://rustup.rs), [Python 3.11+](https://python.org). [XCode on macOS](https://developer.apple.com/xcode/).
+**Prerequisites:** [Bun](https://bun.sh), [Rust](https://rustup.rs), [Python 3.11+](https://python.org), [XCode on macOS](https://developer.apple.com/xcode/).
**Performance:**
- **Apple Silicon (M1/M2/M3)**: Uses MLX backend with native Metal acceleration for 4-5x faster inference