Merge branch 'refs/heads/t/build'
[osl.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 1fb08ebd27ff5d1642288d7cbd2911be3ab9cba9..e37090437c2216aef27e78d9d09a9d6decfc9ca8 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,26 +1,37 @@
-You'll need gcc-4, gnu make and openssl to install libosl. gengetopt
-is needed for the oslfsck executable, and help2man to generate its
-man page.
+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.
 
-Type
+If everything mentioned above is available on your system, type
 
-       make
+               make
 
-to build the library and
+to build the library, the oslfsck executable and the man page. Then
+type
 
-       make install
-       ldconfig
+               make install
 
-as root to install. The default installation prefix is /usr/local. Edit
-Makefile to change the prefix.
+as root to install libosl, oslfsck and the man page. Finally, update
+the library cache by running either
+
+               ldconfig # Linux, *BSD
+
+or
+
+               update_dyld_shared_cache # MacOS
+
+The default installation prefix is /usr/local. Use
+
+               make install PREFIX=/somewhere/else
+
+to install in /somewhere/else instead.
 
 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)
+- [doxygen](http://www.stack.nl/~dimitri/doxygen/)
+- [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.