Personal AI, On Personal Devices
Python
docs: consolidate README sections and add Contributing
Jon Saad-Falcon36554ab0d123
diff --git a/README.md b/README.mdindex 54e79dcd..84fd6c65 100644--- a/README.md+++ b/README.md@@ -46,79 +46,41 @@ You also need a local inference backend: [Ollama](https://ollama.com), [vLLM](ht## Quick Start-The fastest path is Ollama on any machine with Python 3.10+:-```bash-# 1. Install OpenJarvis+# 1. Install and detect hardwaregit clone https://github.com/open-jarvis/OpenJarvis.gitcd OpenJarvisuv sync--# 2. Detect hardware and generate configuv run jarvis init-# 3. Install and start Ollama (https://ollama.com)+# 2. Start Ollama and pull a modelcurl -fsSL https://ollama.com/install.sh | sh-ollama serve # start the Ollama server--# 4. Pull a model+ollama serve &ollama pull qwen3:8b-# 5. Ask a question+# 3. Ask a questionuv run jarvis ask "What is the capital of France?"--# 6. Verify your setup-uv run jarvis doctor-```--`jarvis init` auto-detects your hardware and recommends the best engine. After init, it prints engine-specific next steps. Run `uv run jarvis doctor` at any time to diagnose configuration or connectivity issues.--## Docker--A Docker Compose configuration bundles Jarvis with Ollama:--```bash-# CPU-only (default)-docker compose -f deploy/docker/docker-compose.yml up -d--# NVIDIA GPU (requires NVIDIA Container Toolkit)-docker compose -f deploy/docker/docker-compose.yml \- -f deploy/docker/docker-compose.gpu.nvidia.yml up -d--# AMD GPU (requires ROCm)-docker compose -f deploy/docker/docker-compose.yml \- -f deploy/docker/docker-compose.gpu.rocm.yml up -d--# Pull a model into Ollama-docker compose -f deploy/docker/docker-compose.yml exec ollama ollama pull qwen3:8b```-Services: Jarvis on `:8000`, Ollama on `:11434`.+`jarvis init` auto-detects your hardware and recommends the best engine. Run `uv run jarvis doctor` at any time to diagnose issues.-## Development+Full documentation — including Docker deployment, cloud engines, development setup, and tutorials — at **[open-jarvis.github.io/OpenJarvis](https://open-jarvis.github.io/OpenJarvis/)**.-From source, you need to make sure Rust is installed on System:+## Contributing-```bash-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh-```+We welcome contributions! See the [Contributing Guide](CONTRIBUTING.md) for incentives, contribution types, and the PR process.-Then, you need the Rust extension for full functionality (security, tools, agents, etc.):+Quick start for contributors:```bash-# 1. Clone and install Python depsgit clone https://github.com/open-jarvis/OpenJarvis.gitcd OpenJarvisuv sync --extra dev--# 2. Build and install the Rust extension (requires Rust toolchain)-uv run maturin develop -m rust/crates/openjarvis-python/Cargo.toml--# 3. Run tests+uv run pre-commit installuv run pytest tests/ -v```-See [Contributing](docs/development/contributing.md) for more.+Browse the [Roadmap](https://open-jarvis.github.io/OpenJarvis/development/roadmap/) for areas where help is needed. Comment **"take"** on any issue to get auto-assigned.## About