===================
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