Merge pull request #385 from edmcouncil/readm_file_update

Update of readme file with information about onto-viewer requirements

README.md

@@ -1,20 +1,32 @@
 <img src="https://github.com/edmcouncil/html-pages/raw/develop/general/assets/img/EDM-council-RGB_200w.png" width="200" align="right"/>
 
-# Onto Viewer
+# onto-viewer
 
-Onto Viewer is an open-source project that is hosted by EDM Council. The project started in May 2019. Onto Viewer is a Java application that is specifically designed to access both the ontology structure and its content in the easiest possible way. Onto Viewer servers REST API.
+onto-viewer is an open-source Java application that provides a number of REST API endpoints to access the content of OWL ontologies. If run together with [html-pages frontend](https://github.com/edmcouncil/html-pages), it will visualise them as a web application.
 
-## Onto website
-Onto viewer is used in the ontology view in html-pages.
 
-* https://github.com/edmcouncil/html-pages
+# Table of contents
 
+* [How to run onto-viewer](#how-to-run-onto-viewer)
+	* [How to customise your ontology to be properly displayed by onto-viewer](#how-to-customise-ontologies)
+	* [How to run it locally](#how-to-run-locally)
+	* [How to run it using docker](#how-to-run-docker)
+* [Contributing](#contributing)
+  * [Development](#development)
+* [License](#license)
 
-# How to run Onto Viewer
 
-## Running locally
+# How to run onto-viewer
 
-To run the Onto Viewer locally: 
+## How to customise your ontology to be properly displayed by onto-viewer
+
+1. We require each _ontology IRI_ to follow the convention described in [Vocabularies that use a 'slash namespace'](https://www.w3.org/TR/swbp-vocab-pub/#slash), i.e. end with a forward slash character `/` (e.g., `https://www.omg.org/spec/Commons/Classifiers/`).
+1. We require that all ontologies are "registered" in the meta file(s), which store the relevant metadata, in particular allow for custom modularisation - see https://github.com/edmcouncil/idmp/blob/master/ISO/MetadataISO.rdf for an example of such file.
+1. We recommend that all imported ontologies and locally cached and their local references are listed in catalog-v001.xml file. 
+
+## How to run it locally
+
+To run the onto-viewer locally: 
 
 * Download the file named "onto-viewer.zip" from the [latest release](https://github.com/edmcouncil/onto-viewer/releases). 
 * Unzip the file. 
@@ -30,7 +42,7 @@ java -jar app-v-0.1.0.war
 ```
 
 
-## Run with docker
+## How to run it using docker
 Requirements:
 - [git](https://git-scm.com/) ([install](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git))
 - [docker](https://www.docker.com/) - install:
@@ -130,7 +142,7 @@ docker compose down --rmi all -v
 Please read [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our code of conduct, and the process for submitting pull requests to us.
 
 
-# Development
+## Development
 
 To run integration tests, use the following command: