rarias/ovni
rarias/ovni
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Change the readme to markdown format

Browse Source
This commit is contained in:
Rodrigo Arias 2022-11-04 16:14:05 +01:00
parent a7097048f9
commit b6ece86dc2
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.txt → README.md
View File

@ -1,29 +1,31 @@
![Ovni logo](doc/fig/logo2.png)
ovni - Obtuse but Versatile Nanoscale Instrumentation
The ovni project is composed of a runtime library (libovni.so), which generates 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 which transform the binary trace to the PRV format, suitable to be loaded in
Paraver. Paraver.
The libovni.so library is licensed under MIT, while the rest of tools are GPLv3 The libovni.so library is licensed under MIT, while the rest of tools are GPLv3
unless otherwise stated. unless otherwise stated.
For more information, take a look at the doc/ directory. You can display the For more information, read the [documentation online][doc] or take a look at the
documentation in HTML by running `mkdocs serve` from the root directory. 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 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 $ mkdir build
% cd build $ cd build
% cmake -DCMAKE_INSTALL_PREFIX=$prefix .. $ cmake -DCMAKE_INSTALL_PREFIX=$prefix ..
% make $ make
% make install $ make install
To run the tests you can run (from the build directory): 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 See cmake(1) and cmake-env-variables(7) to see more information about
the variables affecting the generation and build process. the variables affecting the generation and build process.