From 4c4aca677ab62de8c873ebc1db6780baa7ffcb2f Mon Sep 17 00:00:00 2001 From: Bernd Worsch Date: Thu, 30 Oct 2025 02:21:55 +0000 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fcd7b8f..dc7b755 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ -# repo-seed +# PolyCode Simulator (v0.1) -A git repository template to bootstrap coulomb projects from. \ No newline at end of file +## Quickstart + +1) Run a single demo simulation: + +```bash +python simulator.py +``` + +2) Run a tiny parameter sweep (edit ranges inside `experiments.py` for deeper runs): + +```bash +python experiments.py +``` + +Outputs are written to `./runs/`. + +## Files + +- `spec.md` — rigorous protocol description (this repo) +- `README.md` — quickstart +- `simulator.py` — core engine + one‑run demo +- `strategies.py` — pluggable investor/voter strategies +- `experiments.py` — grid sweeps and KPI aggregation +- `params_default.json` — baseline parameters