From b6ece86dc22e60594903e2c6d30a484b0f4951c8 Mon Sep 17 00:00:00 2001 From: Rodrigo Arias Date: Fri, 4 Nov 2022 16:14:05 +0100 Subject: [PATCH] Change the readme to markdown format --- README.txt => README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) rename README.txt => README.md (58%) diff --git a/README.txt b/README.md similarity index 58% rename from README.txt rename to README.md index 645dd30..83dcacb 100644 --- a/README.txt +++ b/README.md @@ -1,29 +1,31 @@ - - ovni - Obtuse but Versatile Nanoscale Instrumentation +![Ovni logo](doc/fig/logo2.png) 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), +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. You can display the -documentation in HTML by running `mkdocs serve` from the root directory. +For more information, read the [documentation online][doc] or take a look at the +doc/ directory. You can display the documentation in HTML by running `mkdocs +serve` from the root directory. + +[doc]: https://ovni.readthedocs.io 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: +To compile in build/ and install into `$prefix` use: - % mkdir build - % cd build - % cmake -DCMAKE_INSTALL_PREFIX=$prefix .. - % make - % make install + $ mkdir build + $ cd build + $ cmake -DCMAKE_INSTALL_PREFIX=$prefix .. + $ make + $ make install To run the tests you can run (from the build directory): - % make test + $ make test See cmake(1) and cmake-env-variables(7) to see more information about the variables affecting the generation and build process.