blob: f2bcb8eb1d62b51ec4a5cd1606d85d4a65b6f823 [file] [log] [blame]
Brian Waters13d96012017-12-08 16:53:31 -06001This package uses CMake (cmake.org) as building system. You'll need the cmake tool in order
2to generate the Makefiles for your platform. You can also select which extensions must be built
3with cmake. After the initial cmake configuration, you will need several tools such as make, a
4C compiler (tested mostly with gcc), flex (> 2.5.4), bison, ...
5
6You may retrieve the source package in several ways:
7 - as a pre-packaged version for your platform. Check the website for supported platforms.
8 - as a tarball containing the source.
9 - directly from the repository using Mercurial tool:
10 hg clone http://www.freediameter.net/hg/freeDiameter
11 In order to update later:
12 hg pull -u
13
14Building in a separate directory is recommended:
15# mkdir build
16# cd build
17# cmake ../
18# make
19
20You can pass options to instruct cmake about which components to compile on the command-line.
21You can also use a CMake front-end (for example ccmake or cmake-gui).
22If your cmake installation is recent, the edit_cache target is a good help as well:
23# mkdir build
24# cd build
25# cmake ../
26# make help
27# make edit_cache
28# make
29
30You can disable the unit tests by doing:
31# cmake -DBUILD_TESTING:BOOL=OFF ../
32# make
33
34When the tests are enabled, you can run them with:
35# make test
36
37See the INSTALL.* files for additional platform-specific information.
38Note that the most up-to-date INSTALL file is the Ubuntu one. You may want to read there
39in addition to your own platform file.