Skip to content

Commit ae90aed

Browse files
committed
Make the README runnable from a cold start
The setup steps assumed you had already cloned the repo and had a working Python. They now start from git clone, name the version required, and create a virtual environment before installing.
1 parent f96ff03 commit ae90aed

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,21 @@ I wrote this after spending a week working out why a published figure was wrong.
66

77
## Try it
88

9+
Needs Python 3.11 or newer. Nothing else — no database, no API keys, no accounts.
10+
911
```bash
12+
git clone https://github.com/Ark2027/impact-data-quality
13+
cd impact-data-quality
14+
15+
python -m venv .venv
16+
source .venv/bin/activate # Windows: .venv\Scripts\activate
17+
1018
pip install -e .
19+
```
20+
21+
Then build the fixtures and audit them:
22+
23+
```bash
1124
python scripts/generate_fixtures.py
1225
python run_audit.py fixtures/submissions --config config/example.json
1326
```

0 commit comments

Comments
 (0)