aboutsummaryrefslogtreecommitdiff
path: root/src/wld/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/wld/README.md')
-rw-r--r--src/wld/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/wld/README.md b/src/wld/README.md
new file mode 100644
index 0000000..1326c25
--- /dev/null
+++ b/src/wld/README.md
@@ -0,0 +1,16 @@
+wld
+===
+wld is a drawing library that targets Wayland. The [swc Wayland compositor
+library](https://github.com/michaelforney/swc) uses wld.
+
+Installing
+==========
+To build and install wld, simply use:
+
+```Bash
+make
+make install
+```
+
+Various flags may be set in config.mk. You will likely want to compile
+using only intel or noveau, not both.