diff README @ 0:3f1cf4a8e31f

initial commit
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 22 Mar 2023 10:16:47 +0100
parents
children 429edc33f20b
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Wed Mar 22 10:16:47 2023 +0100
@@ -0,0 +1,64 @@
+Kitware's VolView plugin for Orthanc
+====================================
+
+
+General information
+-------------------
+
+This repository contains the source code of a plugin to give access to
+Kitware's VolView directly inside Orthanc.
+
+The homepage of VolView can be found at:
+https://volview.kitware.com/
+
+The source code of VolView is available at:
+https://github.com/Kitware/VolView
+
+
+Installation and usage
+----------------------
+
+Build and usage instructions are available in the Orthanc Book:
+http://book.orthanc-server.com/plugins/volview.html
+
+
+Licensing
+---------
+
+- Kitware's VolView is licensed under the Apache 2.0 license.
+
+- The Kitware's VolView plugin for Orthanc is licensed under the GPL
+  license, to fulfill the GPL license of the Orthanc SDK.
+
+- This project is REUSE compliant for its licensing, as established by
+  Free Software Foundation Europe (FSFE):
+  https://reuse.software/
+
+
+Citation
+--------
+
+If you wish to cite Kitware's VolView, please refer to the following
+page:
+https://kitware.github.io/VolView/doc/#Citation
+
+We also kindly ask scientific works and clinical studies that make
+use of Orthanc to cite Orthanc in their associated publications.
+Similarly, we ask open-source and closed-source products that make
+use of Orthanc to warn us about this use. You can cite our work
+using the following BibTeX entry:
+
+@Article{Jodogne2018,
+  author="Jodogne, S{\'e}bastien",
+  title="The {O}rthanc Ecosystem for Medical Imaging",
+  journal="Journal of Digital Imaging",
+  year="2018",
+  month="Jun",
+  day="01",
+  volume="31",
+  number="3",
+  pages="341--352",
+  issn="1618-727X",
+  doi="10.1007/s10278-018-0082-y",
+  url="https://doi.org/10.1007/s10278-018-0082-y"
+}