Mention vm_tester in the documentation

hammerlab · Jul 25, 2018 · 760679c · 760679c
1 parent 8005a18
commit 760679c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -92,6 +92,10 @@ Username matches: `smondet`
 - The file 
   [`src/examples/downloader.ml`](https://github.com/hammerlab/genspio/blob/master/src/examples/downloader.ml)
   contains a (much) bigger example.
+- The file 
+  [`src/examples/vm_tester.ml`](https://github.com/hammerlab/genspio/blob/master/src/examples/vm_tester.ml)
+  is a *“Makefile + scripts”* generator to setup Qemu virtual machines, they can
+  be for instance used to run the tests on more exotic platforms.
 - The project 
   [`hammerlab/secotrec`](https://github.com/hammerlab/secotrec) is a real-world,
   larger-scale use of Genspio (for now using version 0.0.0).

diff --git a/doc/extra-testing.md b/doc/extra-testing.md
@@ -77,3 +77,5 @@ qemu_openwrt_depedencies () {
 ```
 
 You may just run the tests as above.
+
+Note that this setup is also handled by the `vm_tests` example.