annotate INSTALL @ 325:5133b45e3305

Updated documentation
author Sebastien Decugis <sdecugis@nict.go.jp>
date Thu, 20 May 2010 14:23:11 +0900
parents ad3c46016584
children 2bf23d10bc6f
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
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
2 to generate the Makefiles for your platform. You can also select which extensions must be built.
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
3
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
4 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
5 # 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
6 # 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
7 # 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
8 # 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
9
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
10 You can pass options to instruct cmake about which components to compile on the command-line.
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
11 You can also use a CMake front-end (for example ccmake or cmake-gui) or edit the CCmakeCache.txt file directly.
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
12 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
13 # 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
14 # 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
15 # cmake ../
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
16 # 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
17 # 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
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 enable the unit tests by doing:
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
21 # cmake -DSKIP_TESTS:BOOL=OFF ../
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
22 # 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
23 # make tests
0
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
24
1
bafb831ba688 Fix names to proper case for freeDiameter
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 0
diff changeset
25 Note that there are dependencies on external tools that may not be enforced by the configure script.
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 304
diff changeset
26 See the specific INSTALL.* files for additional information.
"Welcome to our mercurial repository"