commit 6b4bc170f9379252b877efced0d1e27428aa9a10
parent da7accd3266a8c9298f252460d2ec529a60ebd65
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 31 Aug 2023 16:17:24 +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 | | | 45 | ++++++++++++++++++++++----------------------- |
1 file changed, 22 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
@@ -1,27 +1,26 @@
# AsToRia: Semi-Transparent Medium
-This C library loads and manages the spectral data of a gas mixture whose
-geometric support are tetrahedra.
-
-## How to build
-
-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
-[Astoria: Thermodynamic Properties](https://gitlab.com/meso-star/atrtp/),
-[RSys](https://gitlab.com/vaplv/rsys/),
-[Star-UnstructuredVolumetricMesh](https://gitlab.com/meso-star/star-uvm/),
-[Star-Mesh](https://gitlab.com/meso-star/star-mesh/) libraries,
-and on [OpenMP](https://www.openmp.org) 1.2 the parallelize its computations.
-
-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.
+This C library loads and manages the geometric data and physical properties of
+a gas mixture.
+
+## Requirements
+
+- C compiler with OpenMP support
+- POSIX make
+- pkg-config
+- [Astoria: Thermodynamic Properties](https://gitlab.com/meso-star/atrtp)
+- [Astoria: Refractive Index](https://gitlab.com/meso-star/atrri)
+- [RSIMD](https://gitlab.com/vaplv/rsimd) (optional)
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [Star Mesh](https://gitlab.com/meso-star/star-mesh)
+- [Star Unstructured Volumetric Mesh](https://gitlab.com/meso-star/star-uvm)
+- [Star VoXel](https://gitlab.com/meso-star/star-vx)
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -34,7 +33,7 @@ for further informations on CMake.
## 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
