annotate README @ 245:1ecb13abdcf2

back to mainline
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 30 Nov 2012 17:09:40 +0100
parents fe180eae201d
children 694f06a84bf4
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
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 General information about this software can be found on our Google
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 Code hosting page:
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
10 http://code.google.com/p/orthanc/
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
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 Currently, the supported platforms are:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * Linux 32bit.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * Linux 64bit.
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
23 * Windows 32bit.
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
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 * Native Linux compilation, with gcc.
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
33 * Native Windows compilation, with Microsoft Visual Studio.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
34 * Cross-compilation for Windows under 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
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
44 Because Orthanc uses the Software-as-a-Service paradigm, commercial
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
45 products are allowed to access the Orthanc REST services and to bundle
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
46 Orthanc in an commercial aggregate.
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
47
52
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 48
diff changeset
48 We also kindly require scientific works and clinical studies that make
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
49 use of Orthanc to cite Orthanc in their associated publications.
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
50
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
51
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
52 Licensing of special directories
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
53 --------------------------------
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
54
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
55 The following directories have separate licensing terms:
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
56
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
57 * The files of the "OrthancCppClient/" directory are licensed under
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
58 the MIT license, which allows commercial products to statically link
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
59 against the C++ client library.
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
60
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
61 * 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
62 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
63
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
64
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 Content
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 -------
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 This archive contains the following directories:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 * Core/ - The core C++ classes (independent of DCMTK)
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
71 * OrthancCppClient/ - Code of the C++ client (under MIT license)
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
72 * OrthancExplorer/ - Code of the Web application (HTML5/Javascript)
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
73 * OrthancServer/ - Code of the Orthanc server (depends on DCMTK)
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 * Resources/ - Scripts, resources for building third-party code
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 * UnitTests/ - Unit tests
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 This archive contains the following files:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 * AUTHORS - The list of the authors
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 * CMakeLists.txt - The main build script
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 * COPYING - The GPLv3 license
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
82 * INSTALL - How to build Orthanc
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 * README - This file
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 * THANKS - The list of the contributors
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
85 * NEWS - The history of main changes between versions
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
87 We have decided not to maintain a separate "ChangeLog" file. Each
57
4bc019d2f969 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 52
diff changeset
88 commit to the official Orthanc Mercurial repository should be
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
89 associated with a description of the changes.