Mercurial > hg > orthanc-book
comparison README.md @ 151:8753cd3e6735
how to contribute
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 29 May 2018 11:53:56 +0200 |
parents | README.txt@2f871e5728fe |
children | 4ee39154c570 |
comparison
equal
deleted
inserted
replaced
150:71d8ce7ff295 | 151:8753cd3e6735 |
---|---|
1 General information | |
2 =================== | |
3 | |
4 Orthanc is a lightweight, RESTful Vendor Neutral Archive for DICOM. | |
5 | |
6 General information about Orthanc can be found on its [official Website](http://www.orthanc-server.com/). | |
7 | |
8 This repository contains the source code of the [Orthanc Book](http://book.orthanc-server.com/), that documents how Orthanc can be used. | |
9 | |
10 | |
11 Setup | |
12 ----- | |
13 | |
14 To build the Orthanc Book from sources, you need to install [Sphinx](http://www.sphinx-doc.org/), the Python Documentation Generator. | |
15 | |
16 | |
17 ### Installing Sphinx under Ubuntu 14.04 LTS ### | |
18 | |
19 # sudo pip install sphinx sphinx_bootstrap_theme | |
20 | |
21 | |
22 Generating the documentation | |
23 ---------------------------- | |
24 | |
25 ### Under Linux ### | |
26 | |
27 # cd ./Sphinx | |
28 # make html | |
29 | |
30 The HTML documentation will be available in the folder | |
31 `./build/html`. You can for instance open it using Mozilla Firefox as | |
32 follows: | |
33 | |
34 # firefox ./build/html/index.html | |
35 | |
36 | |
37 How to contribute | |
38 ----------------- | |
39 | |
40 * Make sure to understand the [reStructuredText file format](https://en.wikipedia.org/wiki/ReStructuredText). | |
41 * Fork this repository onto your BitBucket account. | |
42 * Edit the content of the [`./Sphinx/source/` folder](./Sphinx/source/). | |
43 * Submit a [pull request](https://confluence.atlassian.com/bitbucket/create-a-pull-request-945541466.html) for review by the Orthanc project. | |
44 * 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/). |