Ian Jauslin
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL36
1 files changed, 36 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..a1e1d38
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,36 @@
+#######################################################################
+## ##
+## Compiling and installing hhtop. ##
+## ##
+#######################################################################
+
+* hhtop should work on any POSIX compliant system, such as GNU/Linux or OSX.
+
+* hhtop is linked against the GNU MPFR, GNU GMP, pthread and libinum libraries.
+
+* Compiling:
+ Run
+ make
+
+ This will compile hhtop as well as libinum.
+
+ The default paths can be modified by passing the appropriate arguments to
+ make, as specified in the following table
+ compiler : CC=/usr/bin/gcc
+ linker : LD=/usr/bin/gcc
+ archive : AR=/usr/bin/ar
+ include : INCLUDE=
+ lib paths : LIB=
+ optimize : OPT=-O3
+
+ For example,
+ make CC=/usr/local/bin/gcc INCLUDE=/usr/local/include LIBDIR=-L/usr/local/lib
+
+ In addition, libinum can be linked dynamically or statically, which is
+ controlled by the STATIC option of the makefile.
+ If STATIC=0 then link dynamically
+ If STATIC=2 then link statically
+ If STATIC=1 (default) then link libinum statically but other libraries dynamically.
+
+ The compiled binary is placed in the ./build directory.
+