README
1Orthanc - A Lightweight, RESTful DICOM Server
2=============================================
3
4
5General Information
6-------------------
7
8General information about this software can be found on its official
9Website, and in the Orthanc Book:
10http://www.orthanc-server.com/
11http://book.orthanc-server.com/
12
13The instructions for building Orthanc can be found in the "./INSTALL"
14file.
15
16
17Supported Platforms
18-------------------
19
20Currently, the officially validated platforms are:
21
22* GNU/Linux (32bit and 64bit).
23* Windows (32bit and 64bit).
24* Apple OS X (32bit and 64bit).
25
26Orthanc is known to work on other UNIX-like platforms (such as FreeBSD
27and OpenBSD).
28
29
30Supported Toolchains
31--------------------
32
33Orthanc can currently be built using the following compiling
34toolchains:
35
36* Native GNU/Linux compilation, with gcc.
37* Native Windows compilation, with Microsoft Visual Studio.
38* Cross-compilation for Windows under GNU/Linux, with MinGW.
39
40
41Licensing
42---------
43
44Orthanc is licensed under the GPLv3 license, with the OpenSSL
45exception:
46http://people.gnome.org/~markmc/openssl-and-the-gpl.html
47
48Full information about the licensing of the Orthanc ecosystem is
49available in the Orthanc Book:
50https://book.orthanc-server.com/faq/licensing.html
51
52We also kindly ask scientific works and clinical studies that make
53use of Orthanc to cite Orthanc in their associated publications.
54Similarly, we ask open-source and closed-source products that make
55use of Orthanc to warn us about this use. You can cite our work
56using the following BibTeX entry:
57
58@Article{Jodogne2018,
59 author="Jodogne, S{\'e}bastien",
60 title="The {O}rthanc Ecosystem for Medical Imaging",
61 journal="Journal of Digital Imaging",
62 year="2018",
63 month="Jun",
64 day="01",
65 volume="31",
66 number="3",
67 pages="341--352",
68 issn="1618-727X",
69 doi="10.1007/s10278-018-0082-y",
70 url="https://doi.org/10.1007/s10278-018-0082-y"
71}
72
73
74Licensing of special directories
75--------------------------------
76
77The following directories have separate licensing terms:
78
79* The files of the "./OrthancFramework/Sources/" directory are
80 licensed under the LGPLv3 (Lesser GPL) since Orthanc 1.7.2. The
81 related COPYING file can be found in "./OrthancFramework".
82
83* The files of the "./OrthancFramework/Sources/SQLite/" directory are
84 licensed under the 3-clause BSD license, as they are derived from
85 the Chromium project.
86
87
88Content
89-------
90
91This archive contains the following important directories:
92
93* ./OrthancFramework/Sources/ - The sources of the Orthanc framework
94* ./OrthancFramework/UnitTestsSources/ - Unit tests of the Orthanc framework
95* ./OrthancServer/OrthancExplorer/ - Code of the Orthanc Explorer (HTML5/Javascript)
96* ./OrthancServer/Plugins/ - Code of the plugin framework
97* ./OrthancServer/Resources/Samples/ - Samples
98* ./OrthancServer/Sources/ - Code of the Orthanc server (depends on DCMTK)
99* ./OrthancServer/UnitTestsSources/ - Unit tests of the Orthanc server
100
101This archive contains the following important files:
102
103* ./AUTHORS - The list of the authors
104* ./COPYING - The main GPLv3 license
105* ./INSTALL - How to build Orthanc
106* ./NEWS - The history of main changes between versions
107* ./OrthancServer/CMakeLists.txt - The main build script of the Orthanc server
108* ./README - This file
109
110We have decided not to maintain a separate "ChangeLog" file. Each
111commit to the official Orthanc Mercurial repository should be
112associated with a description of the changes.
113