annotate README @ 52:e0cac5540668

fix
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 07 Sep 2012 12:53:38 +0200
parents 0a04c70747d9
children 4bc019d2f969
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
48
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
1 Palanthir - A Lightweight, RESTful DICOM Server
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
2 ===============================================
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 General Information
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 -------------------
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 General information about this software can be found on our Google
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 Code hosting page:
48
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
9 http://code.google.com/p/palanthir/
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10
48
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
11 The instructions for building Palanthir can be found in the "INSTALL"
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 file.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13
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
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 Supported Toolchains
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
48
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
30 Palanthir can currently be built using the following compiling
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 toolchains:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 * Native Linux compilation, with gcc.
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
34 * Native Windows compilation, with Microsoft Visual Studio.
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
35 * Cross-compilation for Windows under Linux, with MinGW.
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
39 Licensing
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
40 ---------
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
41
48
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
42 Palanthir is licensed under the GPLv3 license. Because Palanthir uses
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
43 the Software-as-a-Service paradigm, commercial products are allowed to
48
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
44 access the Palanthir REST services and to bundle Palanthir in an
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
45 commercial aggregate.
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
46
52
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 48
diff changeset
47 We also kindly require scientific works and clinical studies that make
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 48
diff changeset
48 use of Palanthir to cite Palanthir in their associated publications.
17
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
49
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
48
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
57 * The files of the "PalanthirCppClient/" 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
db4d996ea264 licensing of sqlite
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 13
diff changeset
65
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 Content
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
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 This archive contains the following directories:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 * Core/ - The core C++ classes (independent of DCMTK)
48
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
72 * PalanthirCppClient/ - Code of the C++ client (under MIT license)
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
73 * PalanthirExplorer/ - Code of the Web application (HTML5/Javascript)
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
74 * PalanthirServer/ - Code of the Palanthir server (depends on DCMTK)
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 * Resources/ - Scripts, resources for building third-party code
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 * UnitTests/ - Unit tests
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 files:
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 * AUTHORS - The list of the authors
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 * CMakeLists.txt - The main build script
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 * COPYING - The GPLv3 license
48
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
83 * INSTALL - How to build Palanthir
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 * README - This file
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 * THANKS - The list of the contributors
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
86 * NEWS - The history of main changes between versions
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
88 We have decided not to maintain a separate "ChangeLog" file. Each
48
0a04c70747d9 renaming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
89 commit to the official Palanthir Mercurial repository should be
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
90 associated with a description of the changes.