commit fa3213d9342c8dc118a314c4606adf962bc4ac91
parent c9cab017fd6515a96f2efe6a10ced2e1bb0ab037
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 15 Sep 2023 10:49:50 +0200
Rewrite the README file
Rework the overview section. 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 | | | 43 | +++++++++++++++++++++---------------------- |
1 file changed, 21 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
@@ -1,24 +1,23 @@
# High-Tune: Mie
-This library loads and manages the Mie's data
-
-## How to build
-
-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/), and
-[NetCDF](https://www.unidata.ucar.edu/software/netcdf/) C libraries. It
-optionally depends on [scdoc](https://sr.ht/~sircmpwn/scdoc/) which, if
-available, is used to generate the man pages.
-
-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.
+This C library loads the optical properties of water droplets obtained by a
+Mie scattering evaluation and saved in htmie format. See `htmie.5` for format
+specification.
+
+## Requirements
+
+- C compiler
+- POSIX make
+- pkg-config
+- netCDF4
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [mandoc](https://mandoc.bsd.lv)
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -41,11 +40,11 @@ Fix compilation warnings when using the NetCDF library in version 4.4.0.
- Minor correction of linear interpolation: the interpolation parameter was not
correctly truncated between [0,1] in order to handle numerical inaccuracy.
-## Copyright
+## Copyrights
-Copyright (C) 2018, 2020-2023 [|Méso|Star](http://www.meso-star.com) (<contact@meso-star.com>)
+Copyright (C) 2018, 2020-2023 |Méso|Star> (contact@meso-star.com)
Copyright (C) 2018 Centre National de la Recherche Scientifique (CNRS)
-Copyright (C) 2018 Université Paul Sabatier (<contact-edstar@laplace.univ-tlse.fr>)
+Copyright (C) 2018 Université Paul Sabatier
## License
