From 529cf2da165ae918eb6a510a73267fdb0a9c3e08 Mon Sep 17 00:00:00 2001 From: Rodrigo Arias Date: Fri, 30 Sep 2022 10:35:04 +0200 Subject: [PATCH] Update readme --- README.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.txt b/README.txt index a096a40..645dd30 100644 --- a/README.txt +++ b/README.txt @@ -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: