Mercurial > hg > orthanc
annotate INSTALL @ 631:fc6ad5b97219
fix mainline version
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 25 Oct 2013 14:52:26 +0200 |
parents | dfbd3989a3f9 |
children | d775a3cb5a06 |
rev | line source |
---|---|
57 | 1 Orthanc - A Lightweight, RESTful DICOM Server |
2 ============================================= | |
2 | 3 |
4 | |
5 Dependencies | |
6 ------------ | |
7 | |
57 | 8 1) CMake: Orthanc uses CMake (http://www.cmake.org/) to automate its |
9 building process. | |
7 | 10 |
11 2) Python: Some code is autogenerated through Python | |
12 (http://www.python.org/). | |
2 | 13 |
7 | 14 3) Mercurial: To use the cutting edge code, a Mercurial client must be |
15 installed (http://mercurial.selenic.com/). We recommand TortoiseHg. | |
16 | |
17 W) 7-Zip: For the native build under Windows, the 7-Zip tool is used | |
18 to uncompress the third-party packages (http://www.7-zip.org/). | |
19 | |
20 You thus have to download and install CMake, Python, Mercurial and | |
21 possibly 7-Zip first. The path to their executable must be in the | |
22 "PATH" environment variable. | |
2 | 23 |
24 The other third party dependencies are automatically downloaded by the | |
25 CMake scripts. The downloaded packages are stored in the | |
26 "ThirdPartyDownloads" directory. | |
27 | |
28 | |
57 | 29 Building Orthanc at a glance |
30 ---------------------------- | |
2 | 31 |
57 | 32 To build Orthanc, you must: |
2 | 33 |
34 1) Download the source code (either using Mercurial, or through the | |
35 released versions). For the examples below, we assume the source | |
57 | 36 directory is "~/Orthanc". |
2 | 37 |
38 2) Create a build directory. For the examples below, we assume the | |
57 | 39 build directory is "~/OrthancBuild". |
2 | 40 |
41 | |
42 | |
43 Native Linux Compilation | |
44 ------------------------ | |
45 | |
46 To build binaries with debug information: | |
47 | |
57 | 48 # cd ~/OrthancBuild |
377 | 49 # cmake -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Debug ~/Orthanc |
2 | 50 # make |
51 # make doc | |
52 | |
53 | |
54 To build a release version: | |
55 | |
57 | 56 # cd ~/OrthancBuild |
377 | 57 # cmake -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release ~/Orthanc |
2 | 58 # make |
59 # make doc | |
60 | |
61 | |
57 | 62 Under Linux, you have the possibility to dynamically link Orthanc |
2 | 63 against the shared libraries of your system, provided their version is |
64 recent enough. This greatly speeds up the compilation: | |
65 | |
57 | 66 # cd ~/OrthancBuild |
292 | 67 # cmake -DSTATIC_BUILD=OFF -DCMAKE_BUILD_TYPE=Debug ~/Orthanc |
2 | 68 # make |
69 | |
287
471df5fecb1e
simplification to cmake for dcmtk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
74
diff
changeset
|
70 |
2 | 71 |
385 | 72 Native Windows build with Microsoft Visual Studio 2005 |
73 ------------------------------------------------------ | |
74 | |
75 # cd [...]\OrthancBuild | |
76 # cmake -DSTANDALONE_BUILD=ON -G "Visual Studio 8 2005" [...]\Orthanc | |
77 | |
78 Then open the "[...]/OrthancBuild/Orthanc.sln" with Visual Studio. | |
79 | |
80 NOTES: | |
81 * More recent versions of Visual Studio should also work. | |
82 * You will have to install the Platform SDK (version 6 or above) for | |
83 Visual Studio 2005: | |
84 http://en.wikipedia.org/wiki/Microsoft_Windows_SDK. | |
85 Read the CMake FAQ: http://goo.gl/By90B | |
86 | |
87 | |
88 | |
2 | 89 Cross-Compilation for Windows under Linux |
90 ----------------------------------------- | |
91 | |
92 To cross-compile Windows binaries under Linux using MinGW, please use | |
93 the following command: | |
94 | |
57 | 95 # cd ~/OrthancBuild |
292 | 96 # cmake -DCMAKE_TOOLCHAIN_FILE=~/Orthanc/Resources/MinGWToolchain.cmake -DSTANDALONE_BUILD=ON -DCMAKE_BUILD_TYPE=Debug ~/Orthanc |
2 | 97 # make |
98 | |
99 | |
100 | |
7 | 101 Native Windows build with MinGW (VERY SLOW) |
13
7908a4c25a18
preparation for release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
7
diff
changeset
|
102 ------------------------------------------- |
2 | 103 |
57 | 104 # cd [...]\OrthancBuild |
292 | 105 # cmake -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Debug [...]\Orthanc |
2 | 106 # mingw32-make |
7 | 107 |
108 | |
109 | |
302
238134081136
modification of dicom files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
110 Using ccache |
238134081136
modification of dicom files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
111 ------------ |
238134081136
modification of dicom files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
112 |
238134081136
modification of dicom files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
113 Under Linux, you have the opportunity to use "ccache" to dramatically |
238134081136
modification of dicom files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
114 decrease the compilation time when rebuilding Orthanc. This is |
238134081136
modification of dicom files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
115 especially useful for developers. Under Debian/Ubuntu, you would use: |
238134081136
modification of dicom files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
116 |
238134081136
modification of dicom files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
117 # CC="ccache gcc" CXX="ccache g++" cmake "-DDCMTK_LIBRARIES=wrap;oflog" \ |
238134081136
modification of dicom files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
118 -DSTATIC_BUILD=OFF -DCMAKE_BUILD_TYPE=Debug ~/Orthanc |
238134081136
modification of dicom files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
292
diff
changeset
|
119 |
385 | 120 |
121 | |
122 Troubleshooting | |
123 --------------- | |
124 | |
125 The build instructions for specific Linux distributions are available at the following place: | |
126 https://code.google.com/p/orthanc/wiki/FAQ#I_use_the_Linux_distribution_XXX,_how_can_I_build_Orthanc? |