Mercurial > hg > orthanc
annotate README @ 4291:7e05ad57d7a1
fix formatting for help2man
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 05 Nov 2020 09:57:35 +0100 |
| parents | eea760f20ed2 |
| children | 7822fa96f9c8 |
| rev | line source |
|---|---|
| 57 | 1 Orthanc - A Lightweight, RESTful DICOM Server |
| 2 ============================================= | |
| 3 | |
| 0 | 4 |
| 5 General Information | |
| 6 ------------------- | |
| 7 | |
| 705 | 8 General information about this software can be found on its official |
| 4131 | 9 Website, and in the Orthanc Book: |
| 705 | 10 http://www.orthanc-server.com/ |
| 4131 | 11 http://book.orthanc-server.com/ |
| 0 | 12 |
| 4131 | 13 The instructions for building Orthanc can be found in the "./INSTALL" |
| 0 | 14 file. |
| 15 | |
| 16 | |
| 17 Supported Platforms | |
| 18 ------------------- | |
| 19 | |
| 2661 | 20 Currently, the officially validated platforms are: |
| 0 | 21 |
| 2086 | 22 * GNU/Linux (32bit and 64bit). |
| 2661 | 23 * Windows (32bit and 64bit). |
| 2086 | 24 * Apple OS X (32bit and 64bit). |
| 0 | 25 |
| 2661 | 26 Orthanc is known to work on other UNIX-like platforms (such as FreeBSD |
| 27 and OpenBSD). | |
| 28 | |
| 0 | 29 |
| 30 Supported Toolchains | |
| 31 -------------------- | |
| 32 | |
| 57 | 33 Orthanc can currently be built using the following compiling |
| 0 | 34 toolchains: |
| 35 | |
| 2086 | 36 * Native GNU/Linux compilation, with gcc. |
| 7 | 37 * Native Windows compilation, with Microsoft Visual Studio. |
| 2086 | 38 * Cross-compilation for Windows under GNU/Linux, with MinGW. |
| 0 | 39 |
| 40 | |
| 17 | 41 Licensing |
| 42 --------- | |
| 43 | |
| 136 | 44 Orthanc is licensed under the GPLv3 license, with the OpenSSL |
| 45 exception: | |
| 46 http://people.gnome.org/~markmc/openssl-and-the-gpl.html | |
| 47 | |
|
1230
4f1ac0f2c39c
Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents:
705
diff
changeset
|
48 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
|
49 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
|
50 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
|
51 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
|
52 using the following BibTeX entry: |
| 17 | 53 |
| 2561 | 54 @Article{Jodogne2018, |
| 55 author="Jodogne, S{\'e}bastien", | |
| 56 title="The {O}rthanc Ecosystem for Medical Imaging", | |
| 57 journal="Journal of Digital Imaging", | |
| 58 year="2018", | |
| 2613 | 59 month="Jun", |
| 60 day="01", | |
| 61 volume="31", | |
| 62 number="3", | |
| 63 pages="341--352", | |
| 2561 | 64 issn="1618-727X", |
| 65 doi="10.1007/s10278-018-0082-y", | |
| 66 url="https://doi.org/10.1007/s10278-018-0082-y" | |
| 449 | 67 } |
| 17 | 68 |
| 69 | |
| 70 Licensing of special directories | |
| 71 -------------------------------- | |
| 72 | |
| 73 The following directories have separate licensing terms: | |
| 74 | |
| 4131 | 75 * The files of the "./OrthancFramework/Sources/" directory are |
| 76 licensed under the LGPLv3 (Lesser GPL) since Orthanc 1.7.2. The | |
| 77 related COPYING file can be found in "./OrthancFramework". | |
| 78 | |
| 79 * The files of the "./OrthancFramework/Sources/SQLite/" directory are | |
|
4091
19a2f1d2b816
moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2661
diff
changeset
|
80 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
|
81 the Chromium project. |
| 17 | 82 |
| 83 | |
| 0 | 84 Content |
| 85 ------- | |
| 86 | |
|
4091
19a2f1d2b816
moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2661
diff
changeset
|
87 This archive contains the following important directories: |
| 0 | 88 |
| 4131 | 89 * ./OrthancFramework/Sources/ - The sources of the Orthanc framework |
| 90 * ./OrthancFramework/UnitTestsSources/ - Unit tests of the Orthanc framework | |
| 91 * ./OrthancServer/OrthancExplorer/ - Code of the Orthanc Explorer (HTML5/Javascript) | |
| 92 * ./OrthancServer/Plugins/ - Code of the plugin framework | |
| 93 * ./OrthancServer/Resources/Samples/ - Samples | |
| 94 * ./OrthancServer/Sources/ - Code of the Orthanc server (depends on DCMTK) | |
| 95 * ./OrthancServer/UnitTestsSources/ - Unit tests of the Orthanc server | |
| 0 | 96 |
|
4091
19a2f1d2b816
moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2661
diff
changeset
|
97 This archive contains the following important files: |
| 0 | 98 |
| 4131 | 99 * ./AUTHORS - The list of the authors |
| 100 * ./COPYING - The main GPLv3 license | |
| 101 * ./INSTALL - How to build Orthanc | |
| 102 * ./NEWS - The history of main changes between versions | |
| 103 * ./OrthancServer/CMakeLists.txt - The main build script of the Orthanc server | |
| 104 * ./README - This file | |
| 0 | 105 |
| 7 | 106 We have decided not to maintain a separate "ChangeLog" file. Each |
| 57 | 107 commit to the official Orthanc Mercurial repository should be |
| 7 | 108 associated with a description of the changes. |