Mercurial > hg > freeDiameter
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 642:77c7ec18edec | 643:f065e3cb846e |
|---|---|
| 1 This package uses CMake (cmake.org) as building system. You'll need the cmake tool in order | 1 This package uses CMake (cmake.org) as building system. You'll need the cmake tool in order |
| 2 to generate the Makefiles for your platform. You can also select which extensions must be built. | 2 to generate the Makefiles for your platform. You can also select which extensions must be built |
| 3 with cmake. After the initial cmake configuration, you will need several tools such as make, a | |
| 4 C compiler (tested mostly with gcc), flex, bison, ... | |
| 5 | |
| 6 You 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 | |
| 3 | 13 |
| 4 Building in a separate directory is recommended: | 14 Building in a separate directory is recommended: |
| 5 # mkdir build | 15 # mkdir build |
| 6 # cd build | 16 # cd build |
| 7 # cmake ../ | 17 # cmake ../ |
| 8 # make | 18 # make |
| 9 | 19 |
| 10 You can pass options to instruct cmake about which components to compile on the command-line. | 20 You can pass options to instruct cmake about which components to compile on the command-line. |
| 11 You can also use a CMake front-end (for example ccmake or cmake-gui) or edit the CCmakeCache.txt file directly. | 21 You can also use a CMake front-end (for example ccmake or cmake-gui). |
| 12 If your cmake installation is recent, the edit_cache target is a good help as well: | 22 If your cmake installation is recent, the edit_cache target is a good help as well: |
| 13 # mkdir build | 23 # mkdir build |
| 14 # cd build | 24 # cd build |
| 15 # cmake ../ | 25 # cmake ../ |
| 16 # make help | 26 # make help |
| 18 # make | 28 # make |
| 19 | 29 |
| 20 You can disable the unit tests by doing: | 30 You can disable the unit tests by doing: |
| 21 # cmake -DBUILD_TESTING:BOOL=OFF ../ | 31 # cmake -DBUILD_TESTING:BOOL=OFF ../ |
| 22 # make | 32 # make |
| 33 | |
| 34 When the tests are not disabled, you can run them with: | |
| 23 # make tests | 35 # make tests |
| 24 | 36 |
| 25 Note that there are dependencies on external tools that may not be enforced by the configure script. | 37 See the INSTALL.* files for additional platform-specific information. |
| 26 See the specific INSTALL.* files for additional information. | 38 Note that the most up-to-date INSTALL file is the Ubuntu one. You may want to read there |
| 39 in addition to your own platform file. |