commit 33ac5e21077ae0dd36aa81a711e82aa0018661c3
parent 3146d06527698bf385c0bb7d85b995fcb03aacb3
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 30 Aug 2023 15:52:36 +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, 17 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
@@ -1,24 +1,21 @@
# AsToRia: Refractive Index
-This C library loads the per wavelength refraction index wrt the AtrRI
-fileformat.
-
-## 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 [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 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 documentation](https://cmake.org/documentation)
-for further informations on CMake.
+This C library loads the refractive index by wavelength stored in atrri format.
+See `atrri.5` for format specification.
+
+## Requirements
+
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [mandoc](https://mandoc.bsd.lv)
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -34,7 +31,7 @@ obsolete version 2.8.
## 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) 2021 Centre National de la Recherche Scientifique (CNRS)
## License
