aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMarc André Tanner <mat@brain-dump.org>2016-03-20 10:13:45 +0100
committerMarc André Tanner <mat@brain-dump.org>2016-03-21 11:44:46 +0100
commit66015cde8cb421915553e273adc5917ce75a5e9b (patch)
tree65ff93570d4b4358fb649a6674b65770d37d9f8e /README.md
parenta3ef0d1246f9f0d52f8e705efa7300d68dd81ac3 (diff)
downloadvis-66015cde8cb421915553e273adc5917ce75a5e9b.tar.gz
vis-66015cde8cb421915553e273adc5917ce75a5e9b.tar.xz
build: overhaul build system auto detect stuff using a configure script
The new build instructions are: $ ./configure && make && sudo make install The configure script tries to auto detect support for various libraries and compiler options. These choices can be overwritten by explicitly specifing --{en,dis}able-{lua,selinux,acl}. See ./configure --help for all supported options. The configure script generates config.mk which should allow portable (among GNU and BSD make) Makefiles. Manually editing config.mk is still supported.
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 18 insertions, 16 deletions
diff --git a/README.md b/README.md
index c0bc823..367d020 100644
--- a/README.md
+++ b/README.md
@@ -41,24 +41,26 @@ In order to build vis you will need a C99 compiler as well as:
* [libcurses](http://www.gnu.org/software/ncurses/), preferably in the
wide-character version
* [libtermkey](http://www.leonerd.org.uk/code/libtermkey/)
- * [lua](http://www.lua.org/) >= 5.2
- * [LPeg](http://www.inf.puc-rio.br/~roberto/lpeg/) >= 0.12 (runtime
- dependency required for syntax highlighting)
-
-If you want a self contained statically linked binary you can try
-to run `make standalone` which will attempt to download, compile
-and install all of the above dependencies. `make local` will do
-the same but only for libtermkey, lua and LPeg (i.e. the system
-C and curses libraries are used).
-
-To build a regular dynamically linked binary using the system
-libraries, simply run `make` (possibly after adapting `config.mk`
-to match your system).
-
- $ $EDITOR config.mk
- $ make
+ * [lua](http://www.lua.org/) >= 5.2 (optional)
+ * [LPeg](http://www.inf.puc-rio.br/~roberto/lpeg/) >= 0.12
+ (optional runtime dependency required for syntax highlighting)
+
+Assuming these dependencies are met, execute:
+
+ $ ./configure && make
$ VIS_PATH=. ./vis config.h
+By default the `configure` script will try to auto detect support for
+Lua. See `configure --help` for a list of supported options. You can
+also manually tweak the generated `config.mk` file.
+
+On Linux based systems `make standalone` will attempt to download,
+compile and install all of the above dependencies into a subfolder
+inorder to build a self contained statically linked binary.
+
+`make local` will do the same but only for libtermkey, Lua and LPeg
+(i.e. the system C and curses libraries are used).
+
Editing Features
================