neo_doxygen: Add some unit tests.
[nit.git] / contrib / neo_doxygen / src / tests / README.md
diff --git a/contrib/neo_doxygen/src/tests/README.md b/contrib/neo_doxygen/src/tests/README.md
new file mode 100644 (file)
index 0000000..fbb4393
--- /dev/null
@@ -0,0 +1,7 @@
+Test scripts for `neo_doxygen`.
+
+The name of each test script is prefixed by `neo_doxygen_` to avoid name
+conflicts in `/tests/sav` and `/tests/out`. The expected output of each script
+is saved as a `*.res` file in `/tests/sav`.
+
+Note: All paths indicated here are relative to the root of the repository.