Mercurial > hg > orthanc

comparison INSTALL @ 57:4bc019d2f969 orthanc-renaming

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
renaming
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sun, 16 Sep 2012 09:22:48 +0200
parents 0a04c70747d9
children 09718f2fc5cb
comparison
equal deleted inserted replaced
56:088c4f23e2c8 57:4bc019d2f969
1 Palanthir - A Lightweight, RESTful DICOM Server 1 Orthanc - A Lightweight, RESTful DICOM Server
2 =============================================== 2 =============================================
3 3
4 4
5 Dependencies 5 Dependencies
6 ------------ 6 ------------
7 7
8 1) CMake: Palanthir uses CMake (http://www.cmake.org/) to automate its 8 1) CMake: Orthanc uses CMake (http://www.cmake.org/) to automate its
9 building process. 9 building process.
10 10
11 2) Python: Some code is autogenerated through Python 11 2) Python: Some code is autogenerated through Python
12 (http://www.python.org/). 12 (http://www.python.org/).
13 13
14 3) Mercurial: To use the cutting edge code, a Mercurial client must be 14 3) Mercurial: To use the cutting edge code, a Mercurial client must be
24 The other third party dependencies are automatically downloaded by the 24 The other third party dependencies are automatically downloaded by the
25 CMake scripts. The downloaded packages are stored in the 25 CMake scripts. The downloaded packages are stored in the
26 "ThirdPartyDownloads" directory. 26 "ThirdPartyDownloads" directory.
27 27
28 28
29 Building Palanthir at a glance 29 Building Orthanc at a glance
30 ------------------------------ 30 ----------------------------
31 31
32 To build Palanthir, you must: 32 To build Orthanc, you must:
33 33
34 1) Download the source code (either using Mercurial, or through the 34 1) Download the source code (either using Mercurial, or through the
35 released versions). For the examples below, we assume the source 35 released versions). For the examples below, we assume the source
36 directory is "~/Palanthir". 36 directory is "~/Orthanc".
37 37
38 2) Create a build directory. For the examples below, we assume the 38 2) Create a build directory. For the examples below, we assume the
39 build directory is "~/PalanthirBuild". 39 build directory is "~/OrthancBuild".
40 40
41 41
42 42
43 Native Linux Compilation 43 Native Linux Compilation
44 ------------------------ 44 ------------------------
45 45
46 To build binaries with debug information: 46 To build binaries with debug information:
47 47
48 # cd ~/PalanthirBuild 48 # cd ~/OrthancBuild
49 # cmake -DCMAKE_BUILD_TYPE=DEBUG ~/Palanthir 49 # cmake -DCMAKE_BUILD_TYPE=DEBUG ~/Orthanc
50 # make 50 # make
51 # make doc 51 # make doc
52 52
53 53
54 To build a release version: 54 To build a release version:
55 55
56 # cd ~/PalanthirBuild 56 # cd ~/OrthancBuild
57 # cmake -DCMAKE_BUILD_TYPE=RELEASE ~/Palanthir 57 # cmake -DCMAKE_BUILD_TYPE=RELEASE ~/Orthanc
58 # make 58 # make
59 # make doc 59 # make doc
60 60
61 61
62 Under Linux, you have the possibility to dynamically link Palanthir 62 Under Linux, you have the possibility to dynamically link Orthanc
63 against the shared libraries of your system, provided their version is 63 against the shared libraries of your system, provided their version is
64 recent enough. This greatly speeds up the compilation: 64 recent enough. This greatly speeds up the compilation:
65 65
66 # cd ~/PalanthirBuild 66 # cd ~/OrthancBuild
67 # cmake -DSTATIC_BUILD=OFF -DCMAKE_BUILD_TYPE=DEBUG ~/Palanthir 67 # cmake -DSTATIC_BUILD=OFF -DCMAKE_BUILD_TYPE=DEBUG ~/Orthanc
68 # make 68 # make
69 69
70 70
71 71
72 Cross-Compilation for Windows under Linux 72 Cross-Compilation for Windows under Linux
73 ----------------------------------------- 73 -----------------------------------------
74 74
75 To cross-compile Windows binaries under Linux using MinGW, please use 75 To cross-compile Windows binaries under Linux using MinGW, please use
76 the following command: 76 the following command:
77 77
78 # cd ~/PalanthirBuild 78 # cd ~/OrthancBuild
79 # cmake -DCMAKE_TOOLCHAIN_FILE=~/Palanthir/Resources/MinGWToolchain.cmake -DCMAKE_BUILD_TYPE=DEBUG ~/Palanthir 79 # cmake -DCMAKE_TOOLCHAIN_FILE=~/Orthanc/Resources/MinGWToolchain.cmake -DCMAKE_BUILD_TYPE=DEBUG ~/Orthanc
80 # make 80 # make
81 81
82 82
83 83
84 Native Windows build with MinGW (VERY SLOW) 84 Native Windows build with MinGW (VERY SLOW)
85 ------------------------------------------- 85 -------------------------------------------
86 86
87 # cd [...]\PalanthirBuild 87 # cd [...]\OrthancBuild
88 # cmake -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=DEBUG [...]\Palanthir 88 # cmake -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=DEBUG [...]\Orthanc
89 # mingw32-make 89 # mingw32-make
90 90
91 91
92 92
93 Native Windows build with Microsoft Visual Studio 2005 93 Native Windows build with Microsoft Visual Studio 2005
94 ------------------------------------------------------ 94 ------------------------------------------------------
95 95
96 # cd [...]\PalanthirBuild 96 # cd [...]\OrthancBuild
97 # cmake -G "Visual Studio 8 2005" [...]\Palanthir 97 # cmake -G "Visual Studio 8 2005" [...]\Orthanc
98 98
99 Then open the "[...]/PalanthirBuild/Palanthir.sln" with Visual Studio. 99 Then open the "[...]/OrthancBuild/Orthanc.sln" with Visual Studio.
100 100
101 NOTES: 101 NOTES:
102 * More recent versions of Visual Studio should also work. 102 * More recent versions of Visual Studio should also work.
103 * You might have to install the Platform SDK (version 6 or above): 103 * You might have to install the Platform SDK (version 6 or above):
104 http://en.wikipedia.org/wiki/Microsoft_Windows_SDK. 104 http://en.wikipedia.org/wiki/Microsoft_Windows_SDK.