commit a11b2c9fc07611307154bda29e3af42ea1a2935b parent 07175c421c8082def9e6aa71da3e01e4e89c327d Author: Vincent Forest <vincent.forest@meso-star.com> Date: Tue, 14 Jun 2022 11:49:16 +0200 Add a basic README file Diffstat:
| A | README.md | | | 31 | +++++++++++++++++++++++++++++++ |
1 file changed, 31 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,31 @@ +# Star-CorrelatedK + +This C library loads the radiative properties of an aerosol saved wrt the +Star-Aerosol file format. + +## How to build + +This library is compatible with 64-bits POSIX systems. 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. It optionally depends on +[scdoc](https://sr.ht/~sircmpwn/scdoc/) which, if available, is used to +generate the man page of the Star-Aerosol file format. + +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. + +## Copyright notice + +Copyright (C) 2022 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>). + +## License + +Star-Aerosol 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.