commit c7e3f5589ec195b07b907b2f5554fca7d49922fc parent 8bc6ec42838a7238264bf8aeade7166d2feb66f3 Author: Vincent Forest <vincent.forest@meso-star.com> Date: Wed, 28 Oct 2020 15:27:11 +0100 Add a README file Diffstat:
| A | README.md | | | 26 | ++++++++++++++++++++++++++ |
1 file changed, 26 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,26 @@ +# AsToRia: K correlation + +This C library loads the radiative properties of a gas mixture. + +## 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/) library. + +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). AtrKC +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.