commit ddedd88617be762a3458cfb5c8879b7a5fbc21b2
parent de2b4c7b595b023f5ae787625f1b8c308cac27c5
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 6 Sep 2023 11:32:38 +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 | | | 37 | +++++++++++++++++++------------------ |
1 file changed, 19 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
@@ -1,22 +1,22 @@
# High-Tune: Gas Optical Properties
-This library loads the optical properties of a gas.
+This C library loads the optical properties of a gas mixture stored in htgop
+format. See
+[gas_opt_prop_en.pdf](https://www.meso-star.com/projects/htrdr/downloads/gas_opt_prop_en.pdf)
+for format specification.
-## How to build
+## Requirements
-This program 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.
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
-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.
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -48,8 +48,9 @@ radiation is whether external or internal to the medium, respectively.
## Licenses
-Copyright (C) 2018-2021, 2023 |Méso|Star> (contact@meso-star.com). htgop 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.
+Copyright (C) 2018-2021, 2023 |Méso|Star> (contact@meso-star.com)
+
+htgop 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.
