aboutsummaryrefslogtreecommitdiff
path: root/test/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/README.md')
-rw-r--r--test/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/test/README.md b/test/README.md
new file mode 100644
index 0000000..6577c5c
--- /dev/null
+++ b/test/README.md
@@ -0,0 +1,29 @@
+# Client testing for Lustre runtime
+
+1. Build and test example projects
+2. Build and test vdom
+
+Depends on:
+- `linkedom` - headless DOM testing
+- `npm-run-all` - run watch in parallel
+- `vitest` - execute tests
+
+
+### Commands
+
+Run from the `test` directory
+Each command will run a `build` command to build project dependencies
+
+#### Benchmark
+
+- `npm run bench`
+
+#### Test
+
+- ##### Single
+
+ - `npm run test`
+
+- ##### Watch
+
+ - `npm run test:watch`