annotate README @ 61:2bdb38da2562

contributing
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 14 Aug 2023 10:20:13 +0200
parents 6f504d862494
children 2f162e8b19ba
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 Transfers accelerator plugin for Orthanc
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 ========================================
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 General information
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 -------------------
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 This repository contains the source code of a plugin for Orthanc that
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 speeds up the transfers of DICOM instances over Internet.
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10
6
6f504d862494 documentation is in the Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
11 Instructions for the compilation and usage of the plugin is part of
6f504d862494 documentation is in the Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
12 the Orthanc Book:
6f504d862494 documentation is in the Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
13 http://book.orthanc-server.com/plugins/transfers.html
0
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 Content
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 -------
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * ./Framework/ - Core C++ framework
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * ./Plugin/ - Source code of the plugin
6
6f504d862494 documentation is in the Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
21 * ./Resources/ - Static resources
0
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * ./UnitTestsSources/ - Unit tests
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
61
2bdb38da2562 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 6
diff changeset
25 Contributing
2bdb38da2562 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 6
diff changeset
26 ------------
2bdb38da2562 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 6
diff changeset
27
2bdb38da2562 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 6
diff changeset
28 Instructions for contributing to the Orthanc project are included in
2bdb38da2562 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 6
diff changeset
29 the Orthanc Book:
2bdb38da2562 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 6
diff changeset
30 https://book.orthanc-server.com/developers/repositories.html
2bdb38da2562 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 6
diff changeset
31
2bdb38da2562 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 6
diff changeset
32
0
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 Licensing
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 ---------
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 The transfers accelerator plugin for Orthanc is licensed under the
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 AGPL license.
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 We also kindly ask scientific works and clinical studies that make
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 use of Orthanc to cite Orthanc in their associated publications.
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 Similarly, we ask open-source and closed-source products that make
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 use of Orthanc to warn us about this use. You can cite our work
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 using the following BibTeX entry:
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 @Article{Jodogne2018,
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 author="Jodogne, S{\'e}bastien",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 title="The {O}rthanc Ecosystem for Medical Imaging",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 journal="Journal of Digital Imaging",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 year="2018",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 month="Jun",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 day="01",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 volume="31",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 number="3",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 pages="341--352",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 issn="1618-727X",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 doi="10.1007/s10278-018-0082-y",
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 url="https://doi.org/10.1007/s10278-018-0082-y"
95226b754d9e initial release
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 }