Skip to content

Commit 7284472

Browse files
committed
fix install docs
1 parent 700f92a commit 7284472

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

docs/getting-started/installation.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Prerequisites
44

5-
- Python 3.10 or higher
5+
- Python 3.11 or higher
66
- Git
77
- Virtual environment (recommended)
88

@@ -11,19 +11,26 @@
1111
### 1. Clone the Repository
1212

1313
```bash
14-
git clone https://github.com/SpoonOS/spoon-core.git
14+
git clone https://github.com/XSpoonAi/spoon-core.git
1515
cd spoon-core
1616
```
1717

1818
### 2. Create Virtual Environment
1919

2020
```bash
21+
# macOS/Linux
22+
python3 -m venv spoon-env
23+
source spoon-env/bin/activate
24+
25+
# Windows (PowerShell)
2126
python -m venv spoon-env
22-
source spoon-env/bin/activate # Linux/macOS
23-
# or
24-
spoon-env\Scripts\activate # Windows
27+
.\spoon-env\Scripts\Activate.ps1
2528
```
2629

30+
> 💡 On newer Apple Silicon Macs the `python` shim may not point to Python 3.
31+
> Use `python3` for all commands unless you have explicitly configured `python`
32+
> to target Python 3.10 or later.
33+
2734
### 3. Install Dependencies
2835

2936
```bash
@@ -51,7 +58,7 @@ async def test_installation():
5158
llm_provider="openai", # or your preferred provider
5259
model_name="gpt-4.1" # Framework default
5360
)
54-
61+
5562
# Framework provides automatic validation and error handling
5663
return "✅ SpoonOS framework installed successfully!"
5764

@@ -73,19 +80,11 @@ You should see success messages indicating the framework is ready.
7380
The SpoonOS framework includes built-in validation that automatically:
7481

7582
- Checks API key configuration
76-
- Validates provider connectivity
83+
- Validates provider connectivity
7784
- Ensures proper dependency installation
7885
- Provides clear error messages if issues are found
7986

80-
## Alternative: CLI Interface
81-
82-
You can also test using the CLI interface:
83-
84-
```bash
85-
python main.py
86-
```
87-
8887
## Next Steps
8988

9089
- [Configuration](./configuration.md) - Set up API keys and configuration
91-
- [Quick Start](./quick-start.md) - Build your first agent
90+
- [Quick Start](./quick-start.md) - Build your first agent

0 commit comments

Comments
 (0)