Update README: pip install -e ., .env config with NN default
Browse filesCo-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
README.md
CHANGED
|
@@ -199,19 +199,36 @@ Every tick, each NPC agent runs:
|
|
| 199 |
```bash
|
| 200 |
git clone https://github.com/Bonum/Soci.git
|
| 201 |
cd Soci
|
| 202 |
-
pip install -
|
| 203 |
```
|
| 204 |
|
| 205 |
### Configure
|
| 206 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 207 |
```bash
|
| 208 |
-
#
|
| 209 |
-
|
| 210 |
-
|
| 211 |
-
|
| 212 |
-
#
|
| 213 |
-
|
| 214 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 215 |
```
|
| 216 |
|
| 217 |
### Run
|
|
|
|
| 199 |
```bash
|
| 200 |
git clone https://github.com/Bonum/Soci.git
|
| 201 |
cd Soci
|
| 202 |
+
pip install -e .
|
| 203 |
```
|
| 204 |
|
| 205 |
### Configure
|
| 206 |
|
| 207 |
+
Copy the example env file and edit it:
|
| 208 |
+
|
| 209 |
+
```bash
|
| 210 |
+
cp .env.example .env
|
| 211 |
+
```
|
| 212 |
+
|
| 213 |
+
By default the **NN provider** is active — a local ONNX model, free and fast, no API key needed.
|
| 214 |
+
To switch providers, uncomment the relevant lines in `.env`:
|
| 215 |
+
|
| 216 |
```bash
|
| 217 |
+
# Ollama (local, no key):
|
| 218 |
+
LLM_PROVIDER=ollama
|
| 219 |
+
OLLAMA_MODEL=llama3.1
|
| 220 |
+
|
| 221 |
+
# Gemini (free tier — generous quota):
|
| 222 |
+
LLM_PROVIDER=gemini
|
| 223 |
+
GEMINI_API_KEY=AIza...
|
| 224 |
+
|
| 225 |
+
# Groq (free tier — fast):
|
| 226 |
+
LLM_PROVIDER=groq
|
| 227 |
+
GROQ_API_KEY=gsk_...
|
| 228 |
+
|
| 229 |
+
# Anthropic Claude (paid — highest quality):
|
| 230 |
+
LLM_PROVIDER=claude
|
| 231 |
+
ANTHROPIC_API_KEY=sk-ant-...
|
| 232 |
```
|
| 233 |
|
| 234 |
### Run
|