aboutsummaryrefslogtreecommitdiff
path: root/parity/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'parity/README.md')
-rw-r--r--parity/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/parity/README.md b/parity/README.md
new file mode 100644
index 0000000..dd338bc
--- /dev/null
+++ b/parity/README.md
@@ -0,0 +1,20 @@
+# Render Parity Dataset
+
+This folder stores parity-test input for `crates/render-parity`.
+
+- `cases.toml`: list of deterministic render cases.
+- `reference/*.png`: baseline frames captured from the original renderer.
+
+Expected workflow:
+
+1. Capture baseline PNG frames from original game/editor for each case.
+2. Add entries to `cases.toml`.
+3. Run:
+
+```bash
+cargo run -p render-parity -- \
+ --manifest parity/cases.toml \
+ --output-dir target/render-parity/current
+```
+
+On failure, diff images are saved to `target/render-parity/current/diff`.