Mercurial > hg > freeDiameter

annotate INSTALL @ 1562:6219359a36a9 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge latest changes from proposed branch
author Sebastien Decugis <sdecugis@freediameter.net>
date Mon, 21 Jun 2021 19:08:18 +0800
parents e457e7ac3a6d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
1 This package uses CMake (cmake.org) as building system. You'll need the cmake tool in order
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
2 to generate the Makefiles for your platform. You can also select which extensions must be built
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
3 with cmake. After the initial cmake configuration, you will need several tools such as make, a
811
edb5228bd753 Added instructions for many *BSD systems, thanks to Thomas Klausner for the inputs
Sebastien Decugis <sdecugis@freediameter.net>
parents: 660
diff changeset
4 C compiler (tested mostly with gcc), flex (> 2.5.4), bison, ...
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
5
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
6 You may retrieve the source package in several ways:
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
7 - as a pre-packaged version for your platform. Check the website for supported platforms.
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
8 - as a tarball containing the source.
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
9 - directly from the repository using Mercurial tool:
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
10 hg clone http://www.freediameter.net/hg/freeDiameter
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
11 In order to update later:
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
12 hg pull -u
0
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
13
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
14 Building in a separate directory is recommended:
304
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
15 # mkdir build
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
16 # cd build
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
17 # cmake ../
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
18 # make
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
19
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
20 You can pass options to instruct cmake about which components to compile on the command-line.
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
21 You can also use a CMake front-end (for example ccmake or cmake-gui).
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
22 If your cmake installation is recent, the edit_cache target is a good help as well:
304
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
23 # mkdir build
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
24 # cd build
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
25 # cmake ../
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
26 # make help
304
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
27 # make edit_cache
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
28 # make
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
29
341
2bf23d10bc6f Change the test system to use ctest more efficiently
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
30 You can disable the unit tests by doing:
2bf23d10bc6f Change the test system to use ctest more efficiently
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
31 # cmake -DBUILD_TESTING:BOOL=OFF ../
304
ad3c46016584 Added install directives for cmake; also allow default directory to seek for extensions and configuration files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 300
diff changeset
32 # make
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
33
660
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 643
diff changeset
34 When the tests are enabled, you can run them with:
866
e457e7ac3a6d Fix typo
Sebastien Decugis <sdecugis@freediameter.net>
parents: 811
diff changeset
35 # make test
0
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
36
643
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
37 See the INSTALL.* files for additional platform-specific information.
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
38 Note that the most up-to-date INSTALL file is the Ubuntu one. You may want to read there
f065e3cb846e Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 341
diff changeset
39 in addition to your own platform file.
"Welcome to our mercurial repository"