From 01838f477399ba687795231849ca97f8de213d20 Mon Sep 17 00:00:00 2001 From: tomasmach Date: Fri, 30 Jan 2026 00:35:20 +0100 Subject: [PATCH] docs: add Makefile reference and setup instructions to README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 34d1fa0e..05764497 100644 --- a/README.md +++ b/README.md @@ -207,8 +207,26 @@ 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/voicebox-sh/voicebox.git +cd voicebox + +# Setup everything +make setup + +# Start development +make dev +``` + +**Manual setup (all platforms):** + ```bash # Clone the repo git clone https://github.com/voicebox-sh/voicebox.git