summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorFlorent Le Coz <louiz@louiz.org>2014-06-25 01:02:03 +0200
committerFlorent Le Coz <louiz@louiz.org>2014-06-25 01:02:03 +0200
commit524f7925c44d9445cc4d3024406c80523a4ff9d4 (patch)
tree6de021af5669859adfbeefabc3482e52c7f8efc0 /INSTALL
parent2cf64e10b51579d0bb1d270f82c4fdebf92a6ce6 (diff)
downloadbiboumi-524f7925c44d9445cc4d3024406c80523a4ff9d4.tar.gz
biboumi-524f7925c44d9445cc4d3024406c80523a4ff9d4.tar.bz2
biboumi-524f7925c44d9445cc4d3024406c80523a4ff9d4.tar.xz
biboumi-524f7925c44d9445cc4d3024406c80523a4ff9d4.zip
Add some details in the INSTALL file
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL17
1 files changed, 12 insertions, 5 deletions
diff --git a/INSTALL b/INSTALL
index fbe6623..825f549 100644
--- a/INSTALL
+++ b/INSTALL
@@ -49,11 +49,17 @@ the simplest is to just run
% cmake .
-in the current directory
+in the current directory.
+
+The default build type is "Debug", if you want to build a release version,
+set the CMAKE_BUILD_TYPE variable to "release", by running this command
+instead:
+
+% cmake . -DCMAKE_BUILD_TYPE=release -DCMAKE_INSTALL_PREFIX=/usr
You can also configure many parameters of the build (like customize CFLAGS,
the install path, choose the compiler, or enabling some options like the
-POLLER to use), using:
+POLLER to use), using the ncurses interface of ccmake:
% ccmake .
@@ -61,7 +67,7 @@ In ccmake, first use 'c' to configure the build system, edit the values you
need and finaly use 'g' to generate the Makefiles to build the system and
quit ccmake.
-or
+or you can also use an interactive mode with:
% cmake -i .
@@ -73,6 +79,7 @@ using the POLLER cmake option. Available values are:
POLL: use the standard poll(2). This is the default value on all non-Linux platforms.
Example, configure the poller with cmake:
+
% cmake . -DPOLLER=EPOLL
@@ -80,7 +87,7 @@ Example, configure the poller with cmake:
Build
==============
-- Build the project
+- Once you’ve configured everything using cmake, build the project
% make
@@ -89,7 +96,7 @@ Example, configure the poller with cmake:
Install
=============
-- Install the software system-wide
+- And then, optionaly, Install the software system-wide
# make install