aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index ae9c420..2193a1b 100644
--- a/README.md
+++ b/README.md
@@ -70,8 +70,16 @@ developers can build portable plugin binaries.
Testing
-------
-There are a few unit tests included which can be run with `python waf test
---gui-tests`, but unfortunately manual testing is still required.
+There are a few unit tests included, but unfortunately manual testing is still
+required. The tests and example programs will be built if you pass the
+`--test` option when configuring:
+
+ ./waf configure --test
+
+Then, after building, the unit tests can be run:
+
+ ./waf
+ ./waf test --gui-tests
Several example programs are included that serve as both manual tests and
demonstrations:
@@ -94,6 +102,8 @@ demonstrations:
* `pugl_print_events` is a utility that prints all received events to the
console in a human readable format.
+ * `pugl_cxx_demo` is a simple cube demo that uses the C++ API.
+
All example programs support several command line options to control various
behaviours, see the output of `--help` for details. Please file an issue if
any of these programs do not work as expected on your system.