RayMelius Claude Opus 4.6 commited on
Commit
7c25e4b
·
1 Parent(s): 1e4e81b

Update README: pip install -e ., .env config with NN default

Browse files

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Files changed (1) hide show
  1. README.md +25 -8
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 -r requirements.txt
203
  ```
204
 
205
  ### Configure
206
 
 
 
 
 
 
 
 
 
 
207
  ```bash
208
- # Pick ONE provider (Gemini recommended — free tier is generous):
209
- export GEMINI_API_KEY=AIza... # https://aistudio.google.com/apikey
210
- # or
211
- export GROQ_API_KEY=gsk_... # https://console.groq.com
212
- # or
213
- export ANTHROPIC_API_KEY=sk-ant-...
214
- # or install Ollama and pull a model — no key needed
 
 
 
 
 
 
 
 
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