mirror of
https://github.com/open-jarvis/OpenJarvis.git
synced 2026-07-28 14:07:55 +00:00
docs: add prerequisites section with uv/Rust/Git install instructions
Closes #158 — the README and installation docs assumed uv was already installed without explaining how to get it, creating a barrier for new users (especially on macOS). Adds a prerequisites table to both the README and docs/getting-started/installation.md with platform-specific install commands, and links to the existing macOS step-by-step guide.
This commit is contained in:
@@ -236,11 +236,18 @@ See the [Python SDK guide](../user-guide/python-sdk.md) for the full API referen
|
||||
|
||||
## Requirements
|
||||
|
||||
| Requirement | Version | Notes |
|
||||
|-------------|---------|-------|
|
||||
| Python | 3.10+ | Required |
|
||||
| Inference backend | Any | At least one of Ollama, vLLM, llama.cpp, SGLang, or a cloud API |
|
||||
| Node.js | 18+ | Required for the browser UI; 22+ for the WhatsApp Baileys channel bridge |
|
||||
| Requirement | Version | Install | Notes |
|
||||
|-------------|---------|---------|-------|
|
||||
| Python | 3.10+ | [python.org](https://www.python.org/downloads/) | Required |
|
||||
| uv | latest | `curl -LsSf https://astral.sh/uv/install.sh \| sh` or `brew install uv` (macOS) | Python package & project manager |
|
||||
| Git | any | [git-scm.com](https://git-scm.com/) or `brew install git` (macOS) | Required |
|
||||
| Rust | stable | `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs \| sh` | Required for the Rust extension |
|
||||
| Inference backend | any | See [below](#setting-up-an-inference-backend) | At least one of Ollama, vLLM, llama.cpp, SGLang, or a cloud API |
|
||||
| Node.js | 18+ | [nodejs.org](https://nodejs.org/) or `brew install node` (macOS) | Required for the browser UI; 22+ for the WhatsApp Baileys channel bridge |
|
||||
|
||||
!!! tip "macOS users"
|
||||
See the [macOS Installation Guide](macos.md) for a complete step-by-step walkthrough
|
||||
covering Homebrew, uv, Rust, llama.cpp, and common pitfalls.
|
||||
|
||||
## Optional Extras
|
||||
|
||||
|
||||
Reference in New Issue
Block a user