commit 368e06c394f4d894a70f883569e696576d2dbcb5
parent cb966516bae273fa4455a224885d3f7723934d7b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 21 Oct 2020 10:32:47 +0200
Add a README file
Diffstat:
| A | README.md | | | 30 | ++++++++++++++++++++++++++++++ |
1 file changed, 30 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+# AsToRia: Gas Mixture
+
+This C library loads and manages the spectral data of a gas mixture whose
+geometric support are tetrahedra.
+
+## How to build
+
+This library is compatible GNU/Linux 64-bits. It relies the
+[CMake](http://www.cmake.org) and the
+[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build.
+It also depends on the
+[RSys](https://gitlab.com/vaplv/rsys/),
+[Star-UVM](https://gitlab.com/meso-star/star-uvm/),
+[Star-TetraHedra](https://gitlab.com/meso-star/star-tetrahedra/) libraries,
+and on [OpenMP](https://www.openmp.org) 1.2 the parallelize its computations.
+
+First ensure that CMake is installed on your system. Then install the RCMake
+package as well as the aforementioned prerequisites. Finally generate the
+project from the `cmake/CMakeLists.txt` file by appending to the
+`CMAKE_PREFIX_PATH` variable the install directories of its dependencies. The
+resulting project can be edited, built, tested and installed as any CMake
+project. Refer to the [CMake documentation](https://cmake.org/documentation)
+for further informations on CMake.
+
+## License
+
+Copyright (C) 2020 Centre National de la Recherche Scientifique (CNRS). AtrGM
+is free software released under the GPL v3+ license: GNU GPL version 3 or
+later. You are welcome to redistribute it under certain conditions; refer to
+the COPYING file for details.
