aboutsummaryrefslogtreecommitdiff
path: root/crates/render-parity/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'crates/render-parity/README.md')
-rw-r--r--crates/render-parity/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/crates/render-parity/README.md b/crates/render-parity/README.md
new file mode 100644
index 0000000..a94520e
--- /dev/null
+++ b/crates/render-parity/README.md
@@ -0,0 +1,16 @@
+# render-parity
+
+Deterministic frame-diff runner for `parkan-render-demo`.
+
+Usage:
+
+```bash
+cargo run -p render-parity -- \
+ --manifest parity/cases.toml \
+ --output-dir target/render-parity/current
+```
+
+Options:
+
+- `--demo-bin <path>`: use prebuilt `parkan-render-demo` binary instead of `cargo run`.
+- `--keep-going`: continue all cases even after failures.