git » libjio » commit f63933a

Bring the INSTALL document more up to date

author Alberto Bertogli
2009-03-26 23:27:05 UTC
committer Alberto Bertogli
2009-03-26 23:27:05 UTC
parent 93201c5517f8d992a25bead855ff2b0a4196571e

Bring the INSTALL document more up to date

Signed-off-by: Alberto Bertogli <albertito@blitiri.com.ar>

INSTALL +23 -24

diff --git a/INSTALL b/INSTALL
index 69b49bc..f9b2794 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,38 +1,37 @@
 
-To install the library and the checker (called jiofsck), run as root
+Building and installing
+-----------------------
 
-# make install
+To build and install the library and the checker (called jiofsck), run "make"
+and then "make install" (usually as root). That installs everything using
+/usr/local as the base directory (so the library gets installed in
+/usr/local/lib, the manpage at /usr/local/man, and so on).
 
+To use a different base directory, for example /home/myself, run
+"make PREFIX=/home/myself install".
 
-It will copy the library to /usr/local/lib, manpages to /usr/local/man,
-binaries to /usr/local/bin, and headers to /usr/local/include.
-
-If you want to change the prefix directory (/usr/local by default), for
-instance, to /home/myself/usr; just run:
-
-# make PREFIX=/home/myself/usr install
-
+After installing, you need to run "ldconfig" in order to update your dynamic
+library cache.
 
-This will create inside PREFIX the directories "bin", "lib", "include" and
-"man" if necesary, and put the required files in there.
+If the default "make" is not GNU make (like in BSD systems), use "gmake"
+instead.
 
 
-After installing, you need to run "ldconfig" in order to update your dynamic
-library cache.
+Special builds
+--------------
 
-So, if you want to install to /usr (like most distro bundled software do),
-this is a brief command line summary:
+ - To build with debugging information: "make DEBUG=1".
+ - To build with profiling support: "make PROFILE=1".
+ - To build with fault injection support, if you have libfiu: "make FI=1".
 
-make PREFIX=/usr install
-ldconfig
 
+Python bindings
+---------------
 
-There are other small options that might be useful (like compiling with
-debugging information), you can check the Make.conf file for more information.
+In order to build the Python bindings, you should have libjio already
+installed.
 
-If you use any BSD, or if the default "make" is not GNU make, use "gmake"
-instead.
+To build the bindings, run "make python2". To install them, run
+"make python2_install".
 
-After installing, you're ready to use the library; you can see how by looking
-at the manpage with "man libjio".