Update readme

This commit is contained in:
Rodrigo Arias 2022-09-30 10:35:04 +02:00
parent 4f6d12dc0a
commit 529cf2da16

View File

@ -1,15 +1,16 @@
ovni - Obtuse but Versatile Nanoscale Instrumentation
The ovni instrumentation project is composed of a runtime library (libovni.so),
which generates a fast binary trace, and post-processing tools such as the
emulator (emu), which transform the binary trace to the PRV format, suitable to
be loaded in Paraver.
The ovni project is composed of a runtime library (libovni.so), which generates
a fast binary trace, and post-processing tools such as the emulator (ovniemu),
which transform the binary trace to the PRV format, suitable to be loaded in
Paraver.
The libovni.so library is licensed under MIT, while the rest of tools are GPLv3
unless otherwise stated.
For more information, take a look at the doc/ directory.
For more information, take a look at the doc/ directory. You can display the
documentation in HTML by running `mkdocs serve` from the root directory.
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: