X-Git-Url: http://git.tuebingen.mpg.de/?p=lopsub.git;a=blobdiff_plain;f=README;h=9f77d9eab7fe1ab267faddf00d9c342020cea8f3;hp=a6ffa0b0ce43d6933f52ac03e05c51c051676786;hb=HEAD;hpb=9d3fd447f36e1a144a40037d559a92562d120703 diff --git a/README b/README index a6ffa0b..9f77d9e 100644 --- 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.