Mercurial > hg > orthanc

annotate README @ 4097:99e2054d1e8d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix unit tests for orthanc framework
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 01 Jul 2020 11:15:29 +0200
parents 19a2f1d2b816
children eea760f20ed2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
1 Orthanc - A Lightweight, RESTful DICOM Server
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
2 =============================================
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
3
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 General Information
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 -------------------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7
705
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 563
diff changeset
8 General information about this software can be found on its official
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 563
diff changeset
9 Website:
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 563
diff changeset
10 http://www.orthanc-server.com/
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
12 The instructions for building Orthanc can be found in the "INSTALL"
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 file.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 Supported Platforms
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 -------------------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18
2661
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2613
diff changeset
19 Currently, the officially validated platforms are:
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
21 * GNU/Linux (32bit and 64bit).
2661
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2613
diff changeset
22 * Windows (32bit and 64bit).
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
23 * Apple OS X (32bit and 64bit).
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
2661
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2613
diff changeset
25 Orthanc is known to work on other UNIX-like platforms (such as FreeBSD
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2613
diff changeset
26 and OpenBSD).
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2613
diff changeset
27
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 Supported Toolchains
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 --------------------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
32 Orthanc can currently be built using the following compiling
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 toolchains:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
35 * Native GNU/Linux compilation, with gcc.
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
36 * Native Windows compilation, with Microsoft Visual Studio.
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
37 * Cross-compilation for Windows under GNU/Linux, with MinGW.
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
40 Licensing
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
41 ---------
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
42
136
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
43 Orthanc is licensed under the GPLv3 license, with the OpenSSL
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
44 exception:
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
45 http://people.gnome.org/~markmc/openssl-and-the-gpl.html
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
46
1230
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
47 We also kindly ask scientific works and clinical studies that make
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
48 use of Orthanc to cite Orthanc in their associated publications.
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
49 Similarly, we ask open-source and closed-source products that make
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
50 use of Orthanc to warn us about this use. You can cite our work
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
51 using the following BibTeX entry:
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
52
2561
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
53 @Article{Jodogne2018,
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
54 author="Jodogne, S{\'e}bastien",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
55 title="The {O}rthanc Ecosystem for Medical Imaging",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
56 journal="Journal of Digital Imaging",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
57 year="2018",
2613
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
58 month="Jun",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
59 day="01",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
60 volume="31",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
61 number="3",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
62 pages="341--352",
2561
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
63 issn="1618-727X",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
64 doi="10.1007/s10278-018-0082-y",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
65 url="https://doi.org/10.1007/s10278-018-0082-y"
449
694f06a84bf4 licensing notes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
66 }
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
67
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
68
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
69 Licensing of special directories
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
70 --------------------------------
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
71
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
72 The following directories have separate licensing terms:
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
73
4091
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
74 * The files of the "OrthancFramework/Sources/SQLite/" directory are
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
75 licensed under the 3-clause BSD license, as they are derived from
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
76 the Chromium project.
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
77
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
78
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 Content
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 -------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81
4091
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
82 This archive contains the following important directories:
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
4091
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
84 * OrthancFramework/Sources/ - The sources of the Orthanc framework
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
85 * OrthancFramework/UnitTestsSources/ - Unit tests of the Orthanc framework
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
86 * OrthancServer/OrthancExplorer/ - Code of the Orthanc Explorer (HTML5/Javascript)
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
87 * OrthancServer/Plugins/ - Code of the plugin framework
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
88 * OrthancServer/Resources/Samples/ - Samples
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
89 * OrthancServer/Sources/ - Code of the Orthanc server (depends on DCMTK)
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
90 * OrthancServer/UnitTestsSources/ - Unit tests of the Orthanc server
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
4091
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
92 This archive contains the following important files:
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93
4091
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
94 * AUTHORS - The list of the authors
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
95 * INSTALL - How to build Orthanc
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
96 * NEWS - The history of main changes between versions
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
97 * OrthancFramework/COPYING - The GPLv3 license
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
98 * OrthancServer/CMakeLists.txt - The main build script of the Orthanc server
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
99 * OrthancServer/COPYING - The GPLv3 license
19a2f1d2b816 moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2661
diff changeset
100 * README - This file
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
102 We have decided not to maintain a separate "ChangeLog" file. Each
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
103 commit to the official Orthanc Mercurial repository should be
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
104 associated with a description of the changes.