aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/contrib/examples/highlighter/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--contrib/examples/highlighter/README22
1 files changed, 22 insertions, 0 deletions
diff --git a/contrib/examples/highlighter/README b/contrib/examples/highlighter/README
new file mode 100644
index 0000000..2ea5141
--- /dev/null
+++ b/contrib/examples/highlighter/README
@@ -0,0 +1,22 @@
+wg(8) and wg-quick(8) syntax highlighter library
+================================================
+
+highlighter.c contains a simple portable highlighter for the wg(8) and
+wg-quick(8) configuration files. Simply copy `highlight.c` and
+`highlight.h` into your project wholesale.
+
+As a demo, a simple console highlighter program is included, alongside a
+simple Qt5 GUI app to show its usage in realtime.
+
+There is also a basic fuzzer, because why not?
+
+Usage:
+
+ $ make
+ $ ./highlight < path/to/tunnel.conf
+
+ $ make gui
+ $ ./gui/highlight
+
+ $ make fuzz
+ $ ./fuzz -workers=$(nproc) -jobs=$(nproc) ./corpus