Mercurial > hg > orthanc-book
diff README @ 0:901e8961f46e
initial commit
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 22 Apr 2016 12:57:38 +0200 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README Fri Apr 22 12:57:38 2016 +0200 @@ -0,0 +1,42 @@ +=================== +General information +=================== + +Orthanc is a lightweight, RESTful Vendor Neutral Archive for DICOM. + +General information about Orthanc can be found on its official +Website: http://www.orthanc-server.com/ + +This repository contains the source code of the Orthanc Book, +which documents how Orthanc can be used. + + +===== +Setup +===== + +To build the Orthanc Book from sources, you need to install Sphinx +(http://www.sphinx-doc.org/), the Python Documentation Generator. + + +Installing Sphinx under Ubuntu 14.04 LTS: +----------------------------------------- + +# sudo pip install sphinx sphinx_bootstrap_theme + + +============================ +Generating the documentation +============================ + +Under Linux +----------- + +# cd ./Sphinx +# make html + +The HTML documentation will be available in the folder +"./build/html". You can for instance open it using Mozilla Firefox as +follows: + +# firefox ./build/html/index.html