add test readme

viamrobotics · Nov 29, 2023 · 05d116f · 05d116f
1 parent 07f86a1
commit 05d116f
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/test/README.md b/test/README.md
@@ -0,0 +1,9 @@
+This is a simple test module uploaded during the github action tests defined in .github/workflows/testme.yml
+
+The module.tar.gz was created by running:
+
+```sh
+tar -czf module.tar.gz ./run.sh
+```
+
+The meta.js points to `run.sh` so the tar command must be run from the `test` directory