commit a89459a28310cff8c122edf3aefc68b8879a4a6d parent 9c01474fedd07c6cc57c5376ec468da8820720fe Author: Vincent Forest <vincent.forest@meso-star.com> Date: Fri, 4 Feb 2022 10:58:11 +0100 Add a basic README file Diffstat:
| A | README.md | | | 28 | ++++++++++++++++++++++++++++ |
1 file changed, 28 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,28 @@ +# Star-HITRAN + +Star-HITRAN is C library whose purpose is to load the Line-by-Line data and the +isotopologue metadata from the the [HITRAN database](https://hitran.org/). + +Star-HITRAN relies on 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](https://cmake.org/documentation) for further +informations on CMake. + +## Copyright notice + +Copyright (C) 2022 CNRS - LMD +Copyright (C) 2022 [|Meso|Star>](https://www.meso-star.com) (<contact@meso-star.com>) +Copyright (C) 2022 Université Paul Sabatier - IRIT/Laplace + +## License + +Star-HITRAN 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.