Add .npmrc for bun usage and update dependencies

- Created a new .npmrc file to enforce bun usage. - Bumped version numbers for multiple packages to 0.1.9 in bun.lock. - Added react-sound-visualizer dependency to enhance audio visualization features. - Introduced convert:assets script in package.json for asset optimization. - Updated CONTRIBUTING.md with instructions for converting assets to web formats. - Added documentation files for API endpoints and developer guidelines in the docs directory.
2026-09-19 23:00:45 -07:00 · 2026-01-29 18:56:10 -08:00
parent 462f104494
commit 7b5e73cfa8
58 changed files with 8014 additions and 106 deletions
@@ -0,0 +1,119 @@
+---
+title: "Installation"
+description: "Download and install Voicebox on macOS, Windows, or Linux"
+---
+
+## Download
+
+Voicebox is available for macOS and Windows, with Linux builds coming soon.
+
+<CardGroup cols={2}>
+  <Card title="macOS" icon="apple">
+    Download for Apple Silicon or Intel Macs
+  </Card>
+  <Card title="Windows" icon="windows">
+    Download MSI installer or Setup executable
+  </Card>
+</CardGroup>
+
+### macOS
+
+<Tabs>
+  <Tab title="Apple Silicon">
+    Download: [voicebox_aarch64.app.tar.gz](https://github.com/jamiepine/voicebox/releases/latest/download/voicebox_aarch64.app.tar.gz)
+
+    ```bash
+    # Extract the archive
+    tar -xzf voicebox_aarch64.app.tar.gz
+
+    # Move to Applications
+    mv Voicebox.app /Applications/
+    ```
+  </Tab>
+  <Tab title="Intel">
+    Download: [voicebox_x64.app.tar.gz](https://github.com/jamiepine/voicebox/releases/latest/download/voicebox_x64.app.tar.gz)
+
+    ```bash
+    # Extract the archive
+    tar -xzf voicebox_x64.app.tar.gz
+
+    # Move to Applications
+    mv Voicebox.app /Applications/
+    ```
+  </Tab>
+</Tabs>
+
+### Windows
+
+<Tabs>
+  <Tab title="MSI Installer">
+    Download: [voicebox_x64_en-US.msi](https://github.com/jamiepine/voicebox/releases/latest/download/voicebox_x64_en-US.msi)
+
+    Double-click the MSI file and follow the installation wizard.
+  </Tab>
+  <Tab title="Setup Executable">
+    Download: [voicebox_x64-setup.exe](https://github.com/jamiepine/voicebox/releases/latest/download/voicebox_x64-setup.exe)
+
+    Run the executable and follow the installation wizard.
+  </Tab>
+</Tabs>
+
+### Linux
+
+<Note>
+  Linux builds are coming soon. Currently blocked by GitHub runner disk space limitations.
+</Note>
+
+## First Launch
+
+When you launch Voicebox for the first time:
+
+1. **Model Download** — Qwen3-TTS model (~2-4GB) will download automatically on first use
+2. **Data Directory** — Voice profiles and generated audio are stored in:
+   - macOS: `~/Library/Application Support/com.voicebox.app/`
+   - Windows: `%APPDATA%/com.voicebox.app/`
+   - Linux: `~/.config/com.voicebox.app/`
+
+3. **Backend Server** — The bundled Python server starts automatically
+
+<Tip>
+  First generation will be slower due to model downloads. Subsequent runs use cached models.
+</Tip>
+
+## System Requirements
+
+### Minimum
+
+- **OS:** macOS 11+, Windows 10+, or Linux
+- **RAM:** 8GB
+- **Storage:** 5GB free space (for models and data)
+- **CPU:** Modern multi-core processor
+
+### Recommended
+
+- **RAM:** 16GB+
+- **GPU:** CUDA-capable NVIDIA GPU (for faster generation)
+- **Storage:** 10GB+ free space
+
+<Note>
+  CPU inference is supported but significantly slower than GPU. A CUDA-capable GPU is highly recommended for real-time workflows.
+</Note>
+
+## Verification
+
+After installation, verify everything works:
+
+1. Launch Voicebox
+2. Check the server status indicator in the bottom-left corner (should be green)
+3. Navigate to **Profiles** and create a test profile
+4. Generate a short audio clip to verify the TTS engine works
+
+<Check>
+  If you see a green status indicator and can generate audio, you're all set!
+</Check>
+
+## Next Steps
+
+<Card title="Quick Start Guide" icon="rocket" href="/overview/quick-start">
+  Create your first voice profile and generate speech
+</Card>