annotate INSTALL @ 2:67a6978503b7

fixing Windows build
author Jodogne@Laptop
date Thu, 19 Jul 2012 22:33:27 +0200
parents 3959d33612cc
children 8a7db884ae83
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
1 Palantir - A Lightweight, RESTful DICOM Server
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
2 ==============================================
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
3
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
4
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
5 Dependencies
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
6 ------------
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
7
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
8 Palantir uses CMake (http://www.cmake.org/) to automate its building
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
9 process. You thus have to download and install CMake first.
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
10
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
11 For the native build under Windows, you will also need to download and
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
12 install 7-Zip (http://www.7-zip.org/).
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
13
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
14 The other third party dependencies are automatically downloaded by the
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
15 CMake scripts. The downloaded packages are stored in the
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
16 "ThirdPartyDownloads" directory.
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
17
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
18
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
19 Building Palantir at a glance
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
20 -----------------------------
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
21
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
22 To build Palantir, you must:
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
23
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
24 1) Download the source code (either using Mercurial, or through the
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
25 released versions). For the examples below, we assume the source
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
26 directory is "~/Palantir".
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
27
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
28 2) Create a build directory. For the examples below, we assume the
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
29 build directory is "~/PalantirBuild".
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
30
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
31
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
32
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
33 Native Linux Compilation
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
34 ------------------------
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
35
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
36 To build binaries with debug information:
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
37
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
38 # cd ~/PalantirBuild
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
39 # cmake -DCMAKE_BUILD_TYPE=DEBUG ~/Palantir
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
40 # make
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
41 # make doc
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
42
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
43
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
44 To build a release version:
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
45
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
46 # cd ~/PalantirBuild
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
47 # cmake -DCMAKE_BUILD_TYPE=RELEASE ~/Palantir
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
48 # make
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
49 # make doc
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
50
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
51
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
52 Under Linux, you have the possibility to dynamically link Palantir
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
53 against the shared libraries of your system, provided their version is
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
54 recent enough. This greatly speeds up the compilation:
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
55
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
56 # cd ~/PalantirBuild
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
57 # cmake -DSTATIC_BUILD=OFF -DCMAKE_BUILD_TYPE=DEBUG ~/Palantir
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
58 # make
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
59
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
60
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
61
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
62 Cross-Compilation for Windows under Linux
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
63 -----------------------------------------
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
64
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
65 To cross-compile Windows binaries under Linux using MinGW, please use
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
66 the following command:
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
67
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
68 # cd ~/PalantirBuild
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
69 # cmake -DCMAKE_TOOLCHAIN_FILE=~/Palantir/Resources/MinGWToolchain.cmake -DCMAKE_BUILD_TYPE=DEBUG ~/Palantir
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
70 # make
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
71
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
72
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
73
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
74 Native Windows build with MinGW
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
75 -------------------------------
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
76
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
77 # cd [...]/PalantirBuild
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
78 # cmake -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=DEBUG [...]/Palantir
67a6978503b7 fixing Windows build
Jodogne@Laptop
parents: 0
diff changeset
79 # mingw32-make