From ce138954545a74832efd419c36acd2646faf5ba8 Mon Sep 17 00:00:00 2001 From: David Brodsky Date: Mon, 8 Jan 2007 22:19:59 +0100 Subject: [PATCH] Add INSTALL file. --- INSTALL | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 INSTALL diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..ca84f56 --- /dev/null +++ b/INSTALL @@ -0,0 +1,49 @@ +Tairon installation instructions +================================ + +Requirements +------------ + +1. Linux kernel version 2.6 (Tairon uses epoll interface) +2. Jam build tool - unlike many other programs Tairon uses jam for building. + Jam can be downloaded at http://www.perforce.com/jam/jam.html +3. Sane build environment: C++ compiler (Tairon is tested with GCC 3.4) + + +Configuration +------------- + +Because Tairon uses Jam, all configuration options are located in the Jamfile +file in the package's root directory. Edit this file in your favourite text +editor to adjust settings. There are some interesting variables: + +PREFIX:: + This points to the base directory for installation. It defaults to + /usr/local. + +INCDIR:: + Directory where header files will be installed. Its default is + $(PREFIX)/include directory. + +LIBDIR:: + Directory where libraries will be installed. It defaults to + $(PREFIX)/lib/tairon. + +C++FLAGS:: + Flags that are passed to the compiler during building object (*.o) + files. + +NODEBUG:: + If it is set to 1 then the library will be build without debug + information and it will use optimization (-O2 flag to the compiler). + + +Building and installing +----------------------- + +To build the libraries run `jam` command in the package's root directory. To +install them run `jam install`. Note that this step may need root privileges if +you want to install the libraries system-wide. The final step may be editing +the /etc/ld.so.conf file and adding directory where the libraries are installed +(otherwise programs that want to use this library may not be able to find the +libraries at runtime) and running ldconfig program to update ls.so.cache file. -- 2.11.4.GIT