Mercurial > hg > orthanc

annotate README @ 2648:e1893d31652a jobs

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
serialization of JobHandler
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 31 May 2018 18:44:05 +0200
parents 93dbea1a71e0
children 62cc762d1fb0
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
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
19 Currently, the officially supported 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).
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
22 * Windows 32bit.
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
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 Supported Toolchains
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 --------------------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
29 Orthanc can currently be built using the following compiling
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 toolchains:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
32 * Native GNU/Linux compilation, with gcc.
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
33 * Native Windows compilation, with Microsoft Visual Studio.
2086
630606097798 GNU/Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1403
diff changeset
34 * Cross-compilation for Windows under GNU/Linux, with MinGW.
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
37 Licensing
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
38 ---------
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
39
136
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
40 Orthanc is licensed under the GPLv3 license, with the OpenSSL
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
41 exception:
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
42 http://people.gnome.org/~markmc/openssl-and-the-gpl.html
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
43
1230
4f1ac0f2c39c Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents: 705
diff changeset
44 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
45 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
46 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
47 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
48 using the following BibTeX entry:
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
49
2561
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
50 @Article{Jodogne2018,
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
51 author="Jodogne, S{\'e}bastien",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
52 title="The {O}rthanc Ecosystem for Medical Imaging",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
53 journal="Journal of Digital Imaging",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
54 year="2018",
2613
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
55 month="Jun",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
56 day="01",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
57 volume="31",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
58 number="3",
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2561
diff changeset
59 pages="341--352",
2561
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
60 issn="1618-727X",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
61 doi="10.1007/s10278-018-0082-y",
b2f57399b067 updated bibtex
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2086
diff changeset
62 url="https://doi.org/10.1007/s10278-018-0082-y"
449
694f06a84bf4 licensing notes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
63 }
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
64
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
65
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
66 Licensing of special directories
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 The following directories have separate licensing terms:
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 * The file of the "Core/SQLite/" directory are licensed under the
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
72 3-clause BSD license, as they are derived from the Chromium project.
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
73
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
74
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 Content
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 -------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 This archive contains the following directories:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 * Core/ - The core C++ classes (independent of DCMTK)
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
81 * OrthancExplorer/ - Code of the Web application (HTML5/Javascript)
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
82 * OrthancServer/ - Code of the Orthanc server (depends on DCMTK)
1253
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1230
diff changeset
83 * Plugins/ - Code of the plugin framework
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 * Resources/ - Scripts, resources for building third-party code
1253
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1230
diff changeset
85 * UnitTestsSources/ - Unit tests
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 This archive contains the following files:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 * AUTHORS - The list of the authors
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 * CMakeLists.txt - The main build script
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 * COPYING - The GPLv3 license
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
92 * INSTALL - How to build Orthanc
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 * README - This file
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 * THANKS - The list of the contributors
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
95 * NEWS - The history of main changes between versions
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
97 We have decided not to maintain a separate "ChangeLog" file. Each
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
98 commit to the official Orthanc Mercurial repository should be
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
99 associated with a description of the changes.