Mercurial > hg > orthanc-book
changeset 268:6d54614c6874
readme
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 19 Aug 2019 09:19:46 +0200 |
parents | 0a97b61ae021 |
children | 182f4fdeeb47 |
files | README.md |
diffstat | 1 files changed, 65 insertions(+), 13 deletions(-) [+] |
line wrap: on
line diff
--- a/README.md Mon Aug 19 08:35:48 2019 +0200 +++ b/README.md Mon Aug 19 09:19:46 2019 +0200 @@ -1,17 +1,32 @@ General information =================== -Orthanc is a lightweight, RESTful Vendor Neutral Archive for DICOM. +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/). -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. It also contains the source code of the +documentation of the +[REST API of Orthanc](http://api.orthanc-server.com/). The continuous +integration server (CIS) of Orthanc watches this repository, and +automatically publishes modifications online. -This repository contains the source code of the [Orthanc Book](http://book.orthanc-server.com/), that documents how Orthanc can be used. +Improvements that should be done in the documentation can be reported +onto the +[dedicated issue tracker](https://bitbucket.org/sjodogne/orthanc-book/issues?status=new&status=open). +Orthanc Book +============ + Setup ----- -To build the Orthanc Book from sources, you need to install [Sphinx](http://www.sphinx-doc.org/), the Python Documentation Generator. +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 ### @@ -19,8 +34,8 @@ # sudo pip install sphinx sphinx_bootstrap_theme -Generating the documentation ----------------------------- +Generating the Book +------------------- ### Under Linux ### @@ -34,12 +49,49 @@ # firefox ./build/html/index.html -How to contribute ------------------ +Contributing to the Book +------------------------ - * Make sure to understand the [reStructuredText file format](https://en.wikipedia.org/wiki/ReStructuredText). + * 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/). - * Generate locally the Orthanc Book (cf. above), and make sure it displays properly on your computer. - * 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/). + * Edit the content of the + [`./Sphinx/source/` folder](./Sphinx/source/). + * Generate locally the Orthanc Book (cf. above), and make sure it + displays properly on your computer. + * 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 and accepted, the continuous + integration server of the Orthanc project will automatically + publish the new version [online](http://book.orthanc-server.com/). + + + +REST API of Orthanc +=================== + +Setup +----- + +The REST API of Orthanc is documented according to the +[OpenAPI specification and in the YAML format](https://en.wikipedia.org/wiki/OpenAPI_Specification). + +The source code of the OpenAPI documentation can be found in the file +[./OpenAPI/orthanc-openapi.yaml](./OpenAPI/orthanc-openapi.yaml) +within this repository. + +Contributing to the OpenAPI +--------------------------- + + * Make sure to understand the + [OpenAPI YAML format](https://swagger.io/specification/). + * Fork this repository onto your BitBucket account. + * Edit the content of the + [`./OpenAPI/orthanc-openapi.yaml` file](./OpenAPI/orthanc-openapi.yaml). + * 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 and accepted, the continuous + integration server of the Orthanc project will automatically + publish the new version [online](http://api.orthanc-server.com/).