aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/contrib/examples/highlighter/README
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2019-01-05 17:02:14 +0100
committerJason A. Donenfeld <Jason@zx2c4.com>2019-01-23 14:29:44 +0100
commit7326c8d67afbc7d53ef1dffbfe80a3efb85655a6 (patch)
treeb578c011fead38e96bebc3169209a5f9a4f19f84 /contrib/examples/highlighter/README
parentglobal: normalize -> clamp (diff)
downloadwireguard-monolithic-historical-7326c8d67afbc7d53ef1dffbfe80a3efb85655a6.tar.xz
wireguard-monolithic-historical-7326c8d67afbc7d53ef1dffbfe80a3efb85655a6.zip
contrib: introduce simple highlighter library
Diffstat (limited to 'contrib/examples/highlighter/README')
-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