From f6714816aaf52bdb305fde96415fe6376d232f9d Mon Sep 17 00:00:00 2001 From: buffet Date: Fri, 28 Sep 2018 18:06:34 +0200 Subject: [PATCH] Added building instructions --- README.adoc | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.adoc b/README.adoc index f8cc3d4..f1e740a 100644 --- a/README.adoc +++ b/README.adoc @@ -42,6 +42,28 @@ Configuration languages suck and they add a lot of complexity to a program. This allows you to write your configuration in any language you want, while also removing the task of listening to keybinds for me, since you can use tools like https://github.com/baskerville/sxhkd[sxhkd] to do that. +Building +-------- + +Configuration can be done mostly in link:config.mk[config.mk]. + +In-source +~~~~~~~~~ + +. Be sure to have the dependencies installed (https://en.wikipedia.org/wiki/Literate_programming[Literate]). +. `make` +. `sudo make install` + +Out-of-source +~~~~~~~~~~~~~ + +. Have the dependencies (see above) installed +. `mkdir $builddir` +. `cp config.mk Makefile $builddir` +. `cd $builddir` +. `make SRCPREFIX=..` +. `sudo make install` + Contribution ------------