diff --git a/doc/installation.md b/doc/installation.md new file mode 100644 index 0000000..477ffa8 --- /dev/null +++ b/doc/installation.md @@ -0,0 +1,29 @@ +# Installation + +The ovni project is developed in a [private +repository](https://pm.bsc.es/gitlab/rarias/ovni) and you will need to request +access to fetch the source. However, a public released version is located +in GitHub in the following URL: + + + +To clone the repository use: + + $ git clone https://github.com/bsc-pm/ovni + +## Build + +To build ovni you would need a C compiler, MPI and cmake version 3.20 or newer. +To compile in build/ and install into `$prefix` use: + + $ mkdir build + $ cd build + $ cmake -DCMAKE_INSTALL_PREFIX=$prefix .. + $ make + $ make install + +## Tests + +The tests are executed with `make test`. Keep in mind that to enable runtime +tests you will need to have the Nanos6, nOS-V and NODES libraries too while +configuring the project with cmake. diff --git a/mkdocs.yml b/mkdocs.yml index 5aad544..3bf3204 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,6 +20,7 @@ markdown_extensions: nav: - index.md - concepts.md + - installation.md - 'Runtime': - runtime/tracing.md - runtime/distributed.md