From 70ba5fd07e04b1c0c3f8f176c7dab15e601c5394 Mon Sep 17 00:00:00 2001 From: Christian Henkel Date: Tue, 14 May 2024 13:47:52 +0200 Subject: [PATCH] updated readme with published page Signed-off-by: Christian Henkel --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c88a18e..d247519 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,32 @@ # CONVINCE Toolchain Overview + +> Please access this documentation via [convince-project.github.io/overview](https://convince-project.github.io/overview/) + Welcome to the CONVINCE toolchain documentation. The goal of the [CONVINCE project](http://convince-project.eu) is to provide an open source toolchain to improve robust robot deliberation with the help of planning, learning, and verification techniques. This is the entry-point for the CONVINCE toolchain documentation. It provides an overview of all the individual components which are part of the large toolchain. Those components can be used standalone and also linked together as required for individual use cases. + + + ## Build documentation -To build the documentation page, `plantuml` needs to be installed to generate the interactive overview picture: +To build the documentation page, `plantuml` needs to be installed to generate the interactive overview picture. +Please download version `v1.2024.4` and move it to the correct location: -``` -sudo apt install plantuml +```bash +wget https://github.com/plantuml/plantuml/releases/download/v1.2024.4/plantuml-bsd-1.2024.4.jar +mkdir -p /usr/share/plantuml +sudo mv plantuml-bsd-1.2024.4.jar /usr/share/plantuml/plantuml.jar ``` Then the following command needs to be run to build the documentation: -``` +```bash cd /docs pip install -r requirements.txt make html ``` -It have been tested with Python 3.8.10 and pip version 24.0. \ No newline at end of file +It have been tested with Python 3.8.10 and pip version 24.0.