From 3461a7228083b355702fe5daa0ad13d599db6a1d Mon Sep 17 00:00:00 2001 From: Maximilian Rosin Date: Tue, 1 Jun 2021 10:38:27 +0200 Subject: [PATCH 1/2] Describe setup of OSI visualizer (#61) Signed-off-by: Maximilian Rosin --- doc/setup/building_docker.adoc | 40 ++++++++++++----- doc/setup/building_visualizer.adoc | 42 +++++++++++++---- doc/setup/installing_dependencies.adoc | 62 +++++++++++++++++++++----- 3 files changed, 113 insertions(+), 31 deletions(-) diff --git a/doc/setup/building_docker.adoc b/doc/setup/building_docker.adoc index b20d007..73de704 100644 --- a/doc/setup/building_docker.adoc +++ b/doc/setup/building_docker.adoc @@ -1,11 +1,29 @@ -= Building OSI visualizer Docker file - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file += Building OSI visualizer Docker image + +OSI visualizer provides a Docker file for building a Docker image. +The Docker image bundles all necessary files and dependencies for OSI visualizer. +It enables running OSI visualizer on non-Linux plattforms. + +**Prerequisites** + +* You have installed _Docker_ (version 19.03 or higher) +* You have installed _nvidia-docker2_ + +**Steps** + +. Open a command line interpreter. +. Change to the OSI visualizer repository +. Run the provided script to build the Docker image. ++ +[source] +---- +sh build-nvidia-docker.sh +---- + +**Result** + +The Docker image for OSI visualizer is built. + +**What to do next** + +Run OSI visualizer using Docker \ No newline at end of file diff --git a/doc/setup/building_visualizer.adoc b/doc/setup/building_visualizer.adoc index 3285439..a88c265 100644 --- a/doc/setup/building_visualizer.adoc +++ b/doc/setup/building_visualizer.adoc @@ -1,11 +1,35 @@ = Building OSI visualizer -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file +OSI visualizer provides a script for building OSI visualizer. + +**Prerequisites** + +* You have cloned the OSI visualizer repository. +* You have installed the following dependencies. + It is recommended to install the dependencies using the provided scripts. +** _cmake_ (version 3.5 or higher) +** _Qt_ (version 5.5.0 or higher) +** _ZeroMQ_ including the C++ bindings (version 4.2.1 or higher) +** _Protocol buffers_ (version 2.6.1 or higher) +** _OpenGL_ +** _FMILibrary_ (version 2.0.2 or higher) +** _OSI_ (version 3.1.2 or higher) + +**Steps** + +. Open a command line interpreter. +. Change to the OSI visualizer repository +. Run the provided script to build OSI visualizer. ++ +[source] +---- +bash build.sh +---- + +**Result** + +OSI visualizer is built. + +**What to do next** + +Run OSI visualizer. \ No newline at end of file diff --git a/doc/setup/installing_dependencies.adoc b/doc/setup/installing_dependencies.adoc index 2283b3e..3ff749a 100644 --- a/doc/setup/installing_dependencies.adoc +++ b/doc/setup/installing_dependencies.adoc @@ -1,11 +1,51 @@ -= Installing dependencies - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file += Installing dependencies of OSI visualizer + +OSI visualizer provides scripts for installing all necessary dependencies. +Running the scripts will install the following dependecies: + +* _Git_ +* _cmake_ +* _Qt +* _ZeroMQ_ including its C++ bindings +* _Protocol buffer_ +* _OpenGL_ +* _FMILibrary_ +* _OSI_ + + +**Prerequisites** + +It is recommended to use OSI Visualizer under _Ubuntu Linux 18.04 LTS_. + +**Steps** + +. Open a command line interpreter. +. Change to the OSI visualizer repository +. Run the following command to update the list of available packages and upgrad your system. ++ +[source] +---- +sudo apt-get update && sudo apt-get upgrade && sudo apt-get autoremove +---- ++ +. Run the provided script to install package dependencies. ++ +[source] +---- +sudo bash install-deps.sh +---- ++ +. Run the provided script to install OSI and FMILibrary build dependencies. ++ +[source] +---- +sudo bash build-install-build-deps.sh +---- + +**Result** + +The necessary dependencies are installed. + +**What to do next** + +Build OSI visualizer. \ No newline at end of file From 68e6a625e7453f2491166f1b536e7101838165f2 Mon Sep 17 00:00:00 2001 From: Maximilian Rosin Date: Thu, 24 Jun 2021 14:15:04 +0200 Subject: [PATCH 2/2] fix(docs): Fix typos (#61) Signed-off-by: Maximilian Rosin --- doc/setup/building_docker.adoc | 2 +- doc/setup/building_visualizer.adoc | 2 +- doc/setup/installing_dependencies.adoc | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/setup/building_docker.adoc b/doc/setup/building_docker.adoc index 73de704..0556c7e 100644 --- a/doc/setup/building_docker.adoc +++ b/doc/setup/building_docker.adoc @@ -12,7 +12,7 @@ It enables running OSI visualizer on non-Linux plattforms. **Steps** . Open a command line interpreter. -. Change to the OSI visualizer repository +. Change to the OSI visualizer repository. . Run the provided script to build the Docker image. + [source] diff --git a/doc/setup/building_visualizer.adoc b/doc/setup/building_visualizer.adoc index a88c265..edc1de7 100644 --- a/doc/setup/building_visualizer.adoc +++ b/doc/setup/building_visualizer.adoc @@ -18,7 +18,7 @@ OSI visualizer provides a script for building OSI visualizer. **Steps** . Open a command line interpreter. -. Change to the OSI visualizer repository +. Change to the OSI visualizer repository. . Run the provided script to build OSI visualizer. + [source] diff --git a/doc/setup/installing_dependencies.adoc b/doc/setup/installing_dependencies.adoc index 3ff749a..45def54 100644 --- a/doc/setup/installing_dependencies.adoc +++ b/doc/setup/installing_dependencies.adoc @@ -20,8 +20,8 @@ It is recommended to use OSI Visualizer under _Ubuntu Linux 18.04 LTS_. **Steps** . Open a command line interpreter. -. Change to the OSI visualizer repository -. Run the following command to update the list of available packages and upgrad your system. +. Change to the OSI visualizer repository. +. Run the following command to update the list of available packages and upgrade your system. + [source] ----