Skip to content

Commit 8070b4b

Browse files
committed
docs: update README with clearer setup and testing instructions
- Fix http.server command to serve from site/ directory - Update local data instructions to use balatrobench CLI - Add playwright install command for browser binaries - Mention test server is auto-started by Playwright
1 parent 190386d commit 8070b4b

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,36 +19,39 @@
1919
To run this project locally:
2020

2121
```bash
22-
python3 -m http.server 8000
22+
# Serve from site/ directory
23+
python3 -m http.server 8000 --directory site
2324
```
2425

2526
Then visit [http://localhost:8000](http://localhost:8000)
2627

2728
### Local Data
2829

29-
To test with local benchmark data, symlink the `balatrobot/benchmarks` directory:
30+
Generate benchmark data from BalatroLLM runs:
3031

3132
```bash
32-
ln -s ../balatrobot/benchmarks benchmarks
33+
# Generate benchmark data (requires ../balatrollm/runs symlinked or present)
34+
uv run balatrobench --input-dir runs/v1.0.0
3335
```
3436

35-
Then in `config.js`, comment/uncomment to switch environment to `development`.
37+
Then in `site/config.js`, set `environment: 'development'` to use local data.
3638

3739
## Testing
3840

39-
The project includes end-to-end tests using Playwright. Make sure the local server is running before executing tests.
41+
The project includes end-to-end tests using Playwright.
4042

4143
### Running Tests
4244

4345
```bash
4446
# Install dependencies (first time only)
4547
npm install
48+
npx playwright install # Install browser binaries
4649

4750
# Run tests headless (default)
4851
npm test
4952

5053
# Run tests with interactive UI
51-
npx playwright test --ui
54+
npm run test:ui
5255

5356
# Run tests with browser visible
5457
npm run test:headed
@@ -57,6 +60,8 @@ npm run test:headed
5760
npm run test:debug
5861
```
5962

63+
The test server is automatically started by Playwright (see `playwright.config.js`).
64+
6065
## Upload to CDN
6166

6267
This project make use of BunnyCDN for hosting static assets in benchmarks directory. If you have access to the CDN, you can upload the data with

0 commit comments

Comments
 (0)