Mercurial > hg > freeDiameter
diff INSTALL @ 643:f065e3cb846e 1.0.3
Updated documentation
author | Sebastien Decugis <sdecugis@nict.go.jp> |
---|---|
date | Tue, 21 Dec 2010 10:51:14 +0900 |
parents | 2bf23d10bc6f |
children | a8269458d5b1 |
line wrap: on
line diff
--- a/INSTALL Tue Dec 21 10:30:11 2010 +0900 +++ b/INSTALL Tue Dec 21 10:51:14 2010 +0900 @@ -1,5 +1,15 @@ This package uses CMake (cmake.org) as building system. You'll need the cmake tool in order -to generate the Makefiles for your platform. You can also select which extensions must be built. +to generate the Makefiles for your platform. You can also select which extensions must be built +with cmake. After the initial cmake configuration, you will need several tools such as make, a +C compiler (tested mostly with gcc), flex, bison, ... + +You may retrieve the source package in several ways: + - as a pre-packaged version for your platform. Check the website for supported platforms. + - as a tarball containing the source. + - directly from the repository using Mercurial tool: + hg clone http://www.freediameter.net/hg/freeDiameter + In order to update later: + hg pull -u Building in a separate directory is recommended: # mkdir build @@ -8,7 +18,7 @@ # make You can pass options to instruct cmake about which components to compile on the command-line. -You can also use a CMake front-end (for example ccmake or cmake-gui) or edit the CCmakeCache.txt file directly. +You can also use a CMake front-end (for example ccmake or cmake-gui). If your cmake installation is recent, the edit_cache target is a good help as well: # mkdir build # cd build @@ -20,7 +30,10 @@ You can disable the unit tests by doing: # cmake -DBUILD_TESTING:BOOL=OFF ../ # make + +When the tests are not disabled, you can run them with: # make tests -Note that there are dependencies on external tools that may not be enforced by the configure script. -See the specific INSTALL.* files for additional information. +See the INSTALL.* files for additional platform-specific information. +Note that the most up-to-date INSTALL file is the Ubuntu one. You may want to read there +in addition to your own platform file.