Add README/INSTALL and webpage generation stuff.

[osl.git] / INSTALL

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..1e05b6c
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,24 @@
+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.
+
+Type
+
+       make
+
+to build the library and
+
+       make install
+       ldconfig
+
+as root to install. The default installation prefix is /usr/local. Edit
+Makefile to change the prefix.
+
+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)
+       - man2html
+       - http://www.triptico.com/software/grutatxt.html (grutatxt)
+       - convert (from the ImageMagick package)