Mercurial > hg > orthanc
annotate README @ 5417:2a7a113d791d
merge
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 08 Nov 2023 16:10:46 +0100 |
| parents | 1f7ac929e788 |
| children | 59e3b6f8c5be |
| 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 | |
| 5370 | 41 Contributing |
| 42 ------------ | |
| 43 | |
| 44 Instructions for contributing to the Orthanc project are included in | |
| 45 the Orthanc Book: | |
| 46 https://book.orthanc-server.com/developers/repositories.html | |
| 47 | |
| 48 | |
| 17 | 49 Licensing |
| 50 --------- | |
| 51 | |
| 136 | 52 Orthanc is licensed under the GPLv3 license, with the OpenSSL |
| 53 exception: | |
| 54 http://people.gnome.org/~markmc/openssl-and-the-gpl.html | |
| 55 | |
| 4345 | 56 Full information about the licensing of the Orthanc ecosystem is |
| 57 available in the Orthanc Book: | |
| 58 https://book.orthanc-server.com/faq/licensing.html | |
| 59 | |
|
1230
4f1ac0f2c39c
Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents:
705
diff
changeset
|
60 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
|
61 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
|
62 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
|
63 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
|
64 using the following BibTeX entry: |
| 17 | 65 |
| 2561 | 66 @Article{Jodogne2018, |
| 67 author="Jodogne, S{\'e}bastien", | |
| 68 title="The {O}rthanc Ecosystem for Medical Imaging", | |
| 69 journal="Journal of Digital Imaging", | |
| 70 year="2018", | |
| 2613 | 71 month="Jun", |
| 72 day="01", | |
| 73 volume="31", | |
| 74 number="3", | |
| 75 pages="341--352", | |
| 2561 | 76 issn="1618-727X", |
| 77 doi="10.1007/s10278-018-0082-y", | |
| 78 url="https://doi.org/10.1007/s10278-018-0082-y" | |
| 449 | 79 } |
| 17 | 80 |
| 81 | |
| 82 Licensing of special directories | |
| 83 -------------------------------- | |
| 84 | |
| 85 The following directories have separate licensing terms: | |
| 86 | |
| 4131 | 87 * The files of the "./OrthancFramework/Sources/" directory are |
| 88 licensed under the LGPLv3 (Lesser GPL) since Orthanc 1.7.2. The | |
| 89 related COPYING file can be found in "./OrthancFramework". | |
| 90 | |
| 91 * 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
|
92 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
|
93 the Chromium project. |
| 17 | 94 |
| 95 | |
| 0 | 96 Content |
| 97 ------- | |
| 98 | |
|
4091
19a2f1d2b816
moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2661
diff
changeset
|
99 This archive contains the following important directories: |
| 0 | 100 |
| 4131 | 101 * ./OrthancFramework/Sources/ - The sources of the Orthanc framework |
| 102 * ./OrthancFramework/UnitTestsSources/ - Unit tests of the Orthanc framework | |
| 103 * ./OrthancServer/OrthancExplorer/ - Code of the Orthanc Explorer (HTML5/Javascript) | |
| 104 * ./OrthancServer/Plugins/ - Code of the plugin framework | |
| 105 * ./OrthancServer/Resources/Samples/ - Samples | |
| 106 * ./OrthancServer/Sources/ - Code of the Orthanc server (depends on DCMTK) | |
| 107 * ./OrthancServer/UnitTestsSources/ - Unit tests of the Orthanc server | |
| 0 | 108 |
|
4091
19a2f1d2b816
moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2661
diff
changeset
|
109 This archive contains the following important files: |
| 0 | 110 |
| 4131 | 111 * ./AUTHORS - The list of the authors |
| 112 * ./COPYING - The main GPLv3 license | |
| 113 * ./INSTALL - How to build Orthanc | |
| 114 * ./NEWS - The history of main changes between versions | |
| 115 * ./OrthancServer/CMakeLists.txt - The main build script of the Orthanc server | |
| 116 * ./README - This file | |
| 0 | 117 |
| 7 | 118 We have decided not to maintain a separate "ChangeLog" file. Each |
| 57 | 119 commit to the official Orthanc Mercurial repository should be |
| 7 | 120 associated with a description of the changes. |