diff --git a/README.md b/README.md index 354e58c..62e722a 100644 --- a/README.md +++ b/README.md @@ -70,26 +70,7 @@ This gives you: - Excellent `benchmark setup` / `benchmark run` workflow with warmup, randomization, and mixed chunk sizes - The ability to validate a **just-built binary** end-to-end (caching, coalescing, Range support, memory+disk tiers, GC/eviction, metrics, special endpoints, startup validation, etc.) -#### Quick Start - -```bash -# 1. Build the binary (this also runs short tests) -make build - -# 2. Start a validation-oriented instance (small caches so disk tier + GC get exercised) -# Uses port 80 by default; the script will automatically set the needed -# capability on the binary via sudo setcap if it is missing. -./scripts/validate-with-prefill.sh - -# 3. In another terminal (or on another machine), create a workload once if you haven't already, -# then drive it through your local steamcache2. -# Note: when using a non-80 port you may need to give SteamPrefill the full address. -./scripts/validate-with-prefill.sh # (shows the exact commands with the correct port) -``` - -When the benchmark finishes, press Ctrl-C in the first terminal to cleanly stop the server. - -#### Simple validation server (recommended for manual testing) +#### Validation server (recommended) For easy validation with external tools (SteamPrefill, etc.), use: @@ -140,7 +121,7 @@ Look for: #### The Validation Config -The script uses [docs/examples/validate-config.yaml](docs/examples/validate-config.yaml). It enables both memory and disk tiers at modest sizes (128 MB / 512 MB) with conservative concurrency. Edit or copy it if you need larger caches for bigger workloads. +The recommended validation config is at [docs/examples/validate-config.yaml](docs/examples/validate-config.yaml). It enables both memory and disk tiers at modest sizes (128 MB / 512 MB) with conservative concurrency. Edit or copy it if you need larger caches for bigger workloads. #### What Gets Validated