Merge branch 't/build-improvements'
[lopsub.git] / README
diff --git a/README b/README
index a6ffa0b..9f77d9e 100644 (file)
--- a/README
+++ b/README
@@ -10,3 +10,27 @@ Alternatively, run
        man -l ./lopsub.7.m4
 
 to show build and installation instructions.
+
+Installation
+------------
+Build the package with
+
+       make
+
+The suite parser and the config file parser of the lopsub library are
+both generated by running flex(1), a tool for generating programs
+that perform pattern-matching on text. Hence the flex package must
+be installed for the build to succeed. Next, run
+
+       sudo make install
+
+This will install the package in /usr/local.  If you prefer to install
+as an unprivileged user in /somewhere/else, run
+
+       make PREFIX=/somewhere/else install
+
+instead. In this case, you need to specify -I/somewhere/else/include to
+compile the source files of your application and -L/somewhere/else/lib
+for linking. Alternatively, don't run make install at all and specify
+the path to the top level directory of the repository for both -I
+and -L.