aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTudor Roman2017-02-12 12:20:18 +0200
committerTudor Roman2017-02-12 12:20:18 +0200
commitd1ca1c55d426f9b79a36f4ced0a50962c3462683 (patch)
treed0ecf4cc73fe2f3a3b1718902f544c81e3fdf951
parent4d46281192f98bb8e12bf4aea3e5f91f49b5254c (diff)
downloadruler-d1ca1c55d426f9b79a36f4ced0a50962c3462683.tar.gz
ruler-d1ca1c55d426f9b79a36f4ced0a50962c3462683.zip
readme: building instructions and dependencies
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index d27cc32..b250df7 100644
--- a/README.md
+++ b/README.md
@@ -29,3 +29,26 @@ role="browser"
instance=".*e.*"
echo "warning!" > /tmp/notifyd.fifo
```
+
+Dependencies
+------------
+
+* [xcb](https://xcb.freedesktop.org/)
+* [xcb-util-wm](https://www.archlinux.org/packages/extra/x86_64/xcb-util-wm/) -
+I'm currently working on removing this dependency
+* [libwm](https://github.com/wmutils/libwm)
+
+Build time dependencies:
+
+* a yacc implementation (GNU bison, OpenBSD yacc etc.)
+* a lex implementation (flex)
+
+Building and installing
+-----------------------
+
+```
+$ make
+# make install
+```
+
+The `Makefile` respects the `DESTDIR` and `PREFIX` environment variables.