commit 773646e5166973e7d6870847dd7c4a7f5ae95559
parent e27eec48717645238ccd90847e30d4d936ef1308
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 28 Jul 2023 13:02:43 +0200
Rewrite the README file
Small changes to the overview. Addition of a section on project
requirements and dependencies. Complete rewrite of the installation
procedure concerning the use of POSIX make instead of CMake as the first
build system.
Diffstat:
| M | README.md | | | 33 | ++++++++++++++------------------- |
1 file changed, 14 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
@@ -1,32 +1,27 @@
# Star-CorrelatedK
-This C library loads the radiative properties of a gas mixture saved wrt the
-Star-CK file format.
+This C library loads the radiative properties of a gas mixture saved in sck
+file format. See `sck.5` for the format specification.
-## How to build
+## Requirements
-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-CK file format.
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [mandoc](https://mandoc.bsd.lv)
-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.
+## Installation
-## Copyright notice
+Edit config.mk as needed, then run:
-Copyright (C) 2022, 2023 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>).
-Copyright (C) 2020, 2021 Centre National de la Recherche Scientifique (CNRS).
+ make clean install
## License
+Copyright (C) 2022, 2023 |Méso|Star> (contact@meso-star.com)
+Copyright (C) 2020, 2021 Centre National de la Recherche Scientifique (CNRS)
+
Star-CK 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.
