Merge branch 'refs/heads/t/sha3' into master
[osl.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 7479010fb7aacc7271c90a7950ea5217cda4c9a4..b92a0836d3d6d96991cbd6623dbcaec656d4a75f 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,31 +1,34 @@
-As the bare minimum, you'll need gcc-4 and gnu make to install
-libosl. gengetopt is needed to build the oslfsck executable, and
-help2man to generate its man page.
+Besides a working C compiler, gnu m4, gnu make and the
+[lopsub](http://people.tuebingen.mpg.de/maan/lopsub/) library must be
+installed to to build and install this package. Download and install
+lopsub with
+
+               git clone git://git.tuebingen.mpg.de/lopsub
+               cd lopsub && make && sudo make install
 
 If everything mentioned above is available on your system, type
 
-       make
+               make
+
+to build libosl. Then type
+
+               sudo make install
 
-to build the library, the oslfsck executable and the man page. Then
-type
+to install. Finally, update the library cache by running
 
-       make install
-       ldconfig
+               ldconfig
 
-as root to install libosl, oslfsck and the man page. The default
-installation prefix is /usr/local. Use
+The default installation prefix is `/usr/local`. Use
 
-       make install PREFIX=/somewhere/else
+               make install PREFIX=/somewhere/else
 
-to install in /somewhere/else instead.
+to install in `/somewhere/else` instead.
 
-The make targets in the web/ directory are used for web page generation
+The make targets in the `web/` directory are used for web page generation
 and are not needed to compile, install or use libosl. In order to
 make these targets the following additional tools are needed:
 
-       - http://www.stack.nl/~dimitri/doxygen/ (doxygen)
-       - http://hydra.nac.uci.edu/indiv/ehood/man2html.html (man2html)
-       - http://www.triptico.com/software/grutatxt.html (grutatxt)
-       - convert (from the http://www.imagemagick.org/script/index.php (ImageMagick) package)
+- [discount](http://www.pell.portland.or.us/~orc/Code/discount/)
+- [ImageMagick](http://www.imagemagick.org/script/index.php)
 
 The osl logo was created with Adobe Illustrator by Sebastian Schultheiss.