gsd-parser: Add a README for the regression tests data directory

Rahix · Nov 1, 2024 · 726e274 · 726e274
1 parent 56990b1
commit 726e274
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/gsd-parser/tests/data/README.md b/gsd-parser/tests/data/README.md
@@ -0,0 +1,6 @@
+## `gsd-parser` regression testsuite
+You can place arbitrary `*.gsd` files in this directory to run `gsd-parser` regression tests against them.
+
+**Careful**: You will need to `cargo clean` before the testsuite picks up new files.
+
+The regression tests are implemented using [insta](https://insta.rs/) &mdash; check its documentation for details on usage.