Add installation instructions

This commit is contained in:
Rodrigo Arias 2022-11-11 11:39:41 +01:00
parent b6ece86dc2
commit 4381d601aa
2 changed files with 30 additions and 0 deletions

29
doc/installation.md Normal file
View File

@ -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:
<https://github.com/bsc-pm/ovni>
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.

View File

@ -20,6 +20,7 @@ markdown_extensions:
nav: nav:
- index.md - index.md
- concepts.md - concepts.md
- installation.md
- 'Runtime': - 'Runtime':
- runtime/tracing.md - runtime/tracing.md
- runtime/distributed.md - runtime/distributed.md