Mercurial > hg > orthanc-book
changeset 151:8753cd3e6735
how to contribute
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 29 May 2018 11:53:56 +0200 |
parents | 71d8ce7ff295 |
children | 0fe3156b43a3 |
files | README.md README.txt Sphinx/source/contributing.rst |
diffstat | 3 files changed, 46 insertions(+), 43 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Tue May 29 11:53:56 2018 +0200 @@ -0,0 +1,44 @@ +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](http://book.orthanc-server.com/), that 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 + + +How to contribute +----------------- + + * Make sure to understand the [reStructuredText file format](https://en.wikipedia.org/wiki/ReStructuredText). + * Fork this repository onto your BitBucket account. + * Edit the content of the [`./Sphinx/source/` folder](./Sphinx/source/). + * Submit a [pull request](https://confluence.atlassian.com/bitbucket/create-a-pull-request-945541466.html) for review by the Orthanc project. + * Once the pull request is reviewed, the continuous integration server of the Orthanc project will automatically publish the new version [online](http://book.orthanc-server.com/).
--- a/README.txt Tue May 29 09:40:28 2018 +0000 +++ /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
--- a/Sphinx/source/contributing.rst Tue May 29 09:40:28 2018 +0000 +++ b/Sphinx/source/contributing.rst Tue May 29 11:53:56 2018 +0200 @@ -36,7 +36,8 @@ <https://github.com/jodogne/OrthancContributed>`_" public GitHub repository, via pull requests. - Improve the text of the `Orthanc Book - <https://bitbucket.org/sjodogne/orthanc-book/src/default/Sphinx/source/>`_. + <https://bitbucket.org/sjodogne/orthanc-book/>`_ (check out the "How to contribute" + section in the README). - The Orthanc project will also happily accept **external patches** in the core of Orthanc and in its associated official plugins. Such patches can either be sent to the `mailing list