commit b7448c8fd60c12af1f910a5b71ab433bdf30b9f4
parent 0993403b7f2bb7e5236e267aad93481dc742329f
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 30 Aug 2023 17:17: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:
1 file changed, 13 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
@@ -1,24 +1,21 @@
# AsToRia: Thermodynamic Properties
This C library loads the thermodynamic properties of a gas mixture.
+See `atrtp.5` for format specification.
-## How to build
+## Requirements
-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. It optionally depends on
-the [AsciiDoc](https://asciidoc.org/) suite of tools; if available, the man
-pages of the reference documentation will be generated.
+- 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
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -28,7 +25,7 @@ Use scdoc rather than asciidoc as file format for man sources.
## Copyright
-Copyright (C) 2022, 2023 [|Méso|Star](http://www.meso-star.com) (<contact@meso-star.com>)
+Copyright (C) 2022, 2023 |Méso|Star (contact@meso-star.com)
Copyright (C) 2020, 2021 Centre National de la Recherche Scientifique (CNRS)
## License
