docs: Fix installation instructions to require cloning repository first
Changed:
- Replaced misleading one-liner curl command with explicit clone + setup flow
- Updated 'Quick Install' section to show 3 clear steps
- Updated 'Installation (Step by Step)' to include clone step
- Changed step numbering from 4 to 5 steps total
- Made it clear that setup.sh must be run from within the repo
The setup.sh script requires relative paths to work, so users must
clone the repository first before running setup.
This matches standard Git project workflows and is now honest about
what's required to get the full installation.
🤖 Generated with Claude Code
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
3ba98fc330
commit
2910783a1c
1 changed files with 25 additions and 15 deletions
40
README.md
40
README.md
|
|
@ -78,15 +78,23 @@
|
|||
|
||||
---
|
||||
|
||||
### One-Line Installer ✨
|
||||
### Quick Install (3 Steps)
|
||||
|
||||
**Once you have Python 3.11+ and Git, run this command:**
|
||||
**Once you have Python 3.11+ and Git, run these commands:**
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/brobertsaz/claude-os/main/setup.sh | bash
|
||||
# 1. Clone the repository
|
||||
git clone https://github.com/brobertsaz/claude-os.git
|
||||
cd claude-os
|
||||
|
||||
# 2. Run the setup script
|
||||
./setup.sh
|
||||
|
||||
# 3. Start all services
|
||||
./start_all_services.sh
|
||||
```
|
||||
|
||||
**The script will automatically:**
|
||||
**The setup script will automatically:**
|
||||
- ✅ Install Ollama (if needed) + download LLM models
|
||||
- ✅ Install Redis (if needed) for caching/queues
|
||||
- ✅ Set up Python virtual environment
|
||||
|
|
@ -94,11 +102,6 @@ curl -fsSL https://raw.githubusercontent.com/brobertsaz/claude-os/main/setup.sh
|
|||
- ✅ Create SQLite database
|
||||
- ✅ Install frontend dependencies (if Node.js present)
|
||||
|
||||
**Then start services:**
|
||||
```bash
|
||||
./start_all_services.sh
|
||||
```
|
||||
|
||||
**Done!** Visit http://localhost:5173 to start using Claude OS.
|
||||
|
||||
### Installation (Step by Step)
|
||||
|
|
@ -140,12 +143,19 @@ git --version # Should exist
|
|||
|
||||
---
|
||||
|
||||
**Step 2: Run the Installer**
|
||||
|
||||
Once you have Python 3.11+ and Git:
|
||||
**Step 2: Clone the Repository**
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/brobertsaz/claude-os/main/setup.sh | bash
|
||||
git clone https://github.com/brobertsaz/claude-os.git
|
||||
cd claude-os
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Step 3: Run the Installer**
|
||||
|
||||
```bash
|
||||
./setup.sh
|
||||
```
|
||||
|
||||
This automatically installs:
|
||||
|
|
@ -159,7 +169,7 @@ The script will download ~5-10 GB of LLM models (llama3.1, embeddings).
|
|||
|
||||
---
|
||||
|
||||
**Step 3: Start Services**
|
||||
**Step 4: Start Services**
|
||||
|
||||
```bash
|
||||
./start_all_services.sh
|
||||
|
|
@ -174,7 +184,7 @@ This starts:
|
|||
|
||||
---
|
||||
|
||||
**Step 4: Access the Application**
|
||||
**Step 5: Access the Application**
|
||||
|
||||
Open your browser and visit:
|
||||
- **Frontend:** http://localhost:5173
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue