Mercurial > hg > orthanc-book
changeset 141:2f871e5728fe
rename
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 29 May 2018 08:44:41 +0200 |
parents | ec849c2ee427 |
children | 5846dab98de2 71d8ce7ff295 |
files | README README.txt |
diffstat | 2 files changed, 42 insertions(+), 42 deletions(-) [+] |
line wrap: on
line diff
--- a/README Fri May 25 17:26:57 2018 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,42 +0,0 @@ -=================== -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
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.txt Tue May 29 08:44:41 2018 +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