Mercurial > hg > orthanc
annotate README @ 3383:367d0b618d70
todo
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 28 May 2019 17:31:44 +0200 |
| parents | 62cc762d1fb0 |
| children | 19a2f1d2b816 |
| 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 |
| 9 Website: | |
| 10 http://www.orthanc-server.com/ | |
| 0 | 11 |
| 57 | 12 The instructions for building Orthanc can be found in the "INSTALL" |
| 0 | 13 file. |
| 14 | |
| 15 | |
| 16 Supported Platforms | |
| 17 ------------------- | |
| 18 | |
| 2661 | 19 Currently, the officially validated platforms are: |
| 0 | 20 |
| 2086 | 21 * GNU/Linux (32bit and 64bit). |
| 2661 | 22 * Windows (32bit and 64bit). |
| 2086 | 23 * Apple OS X (32bit and 64bit). |
| 0 | 24 |
| 2661 | 25 Orthanc is known to work on other UNIX-like platforms (such as FreeBSD |
| 26 and OpenBSD). | |
| 27 | |
| 0 | 28 |
| 29 Supported Toolchains | |
| 30 -------------------- | |
| 31 | |
| 57 | 32 Orthanc can currently be built using the following compiling |
| 0 | 33 toolchains: |
| 34 | |
| 2086 | 35 * Native GNU/Linux compilation, with gcc. |
| 7 | 36 * Native Windows compilation, with Microsoft Visual Studio. |
| 2086 | 37 * Cross-compilation for Windows under GNU/Linux, with MinGW. |
| 0 | 38 |
| 39 | |
| 17 | 40 Licensing |
| 41 --------- | |
| 42 | |
| 136 | 43 Orthanc is licensed under the GPLv3 license, with the OpenSSL |
| 44 exception: | |
| 45 http://people.gnome.org/~markmc/openssl-and-the-gpl.html | |
| 46 | |
|
1230
4f1ac0f2c39c
Fix licensing terms according to FSF recommendations
s.jodogne@gmail.com
parents:
705
diff
changeset
|
47 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
|
48 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
|
49 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
|
50 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
|
51 using the following BibTeX entry: |
| 17 | 52 |
| 2561 | 53 @Article{Jodogne2018, |
| 54 author="Jodogne, S{\'e}bastien", | |
| 55 title="The {O}rthanc Ecosystem for Medical Imaging", | |
| 56 journal="Journal of Digital Imaging", | |
| 57 year="2018", | |
| 2613 | 58 month="Jun", |
| 59 day="01", | |
| 60 volume="31", | |
| 61 number="3", | |
| 62 pages="341--352", | |
| 2561 | 63 issn="1618-727X", |
| 64 doi="10.1007/s10278-018-0082-y", | |
| 65 url="https://doi.org/10.1007/s10278-018-0082-y" | |
| 449 | 66 } |
| 17 | 67 |
| 68 | |
| 69 Licensing of special directories | |
| 70 -------------------------------- | |
| 71 | |
| 72 The following directories have separate licensing terms: | |
| 73 | |
| 74 * The file of the "Core/SQLite/" directory are licensed under the | |
| 75 3-clause BSD license, as they are derived from the Chromium project. | |
| 76 | |
| 77 | |
| 0 | 78 Content |
| 79 ------- | |
| 80 | |
| 81 This archive contains the following directories: | |
| 82 | |
| 83 * Core/ - The core C++ classes (independent of DCMTK) | |
| 57 | 84 * OrthancExplorer/ - Code of the Web application (HTML5/Javascript) |
| 85 * OrthancServer/ - Code of the Orthanc server (depends on DCMTK) | |
| 1253 | 86 * Plugins/ - Code of the plugin framework |
| 0 | 87 * Resources/ - Scripts, resources for building third-party code |
| 1253 | 88 * UnitTestsSources/ - Unit tests |
| 0 | 89 |
| 90 This archive contains the following files: | |
| 91 | |
| 92 * AUTHORS - The list of the authors | |
| 93 * CMakeLists.txt - The main build script | |
| 94 * COPYING - The GPLv3 license | |
| 57 | 95 * INSTALL - How to build Orthanc |
| 0 | 96 * README - This file |
| 97 * THANKS - The list of the contributors | |
| 7 | 98 * NEWS - The history of main changes between versions |
| 0 | 99 |
| 7 | 100 We have decided not to maintain a separate "ChangeLog" file. Each |
| 57 | 101 commit to the official Orthanc Mercurial repository should be |
| 7 | 102 associated with a description of the changes. |