commit 85c9053556e01c0ee427394bf44b28caf200b256
parent 928bf6440ded35d65e6a5a1bf3fc930188dc2e5f
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 28 Jul 2023 17:02:40 +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,25 +1,21 @@
# ModRadUrb: MaTeriaL
-This project defines the fileformat used to describe the spectral of a material
-and provide a library to load these data.
+This C library loads spectrally variable materials saved in mrumtl format. See
+`mrumtl.5` for the format specification.
-## How to build
+## Requirements
-The `mrumtl` library is compatible GNU/Linux 64-bits. It relies on the
-[CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. They also depend
-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 page of the file format.
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [mandoc](https://mandoc.bsd.lv)
-To build the library, 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
@@ -44,7 +40,8 @@ for further informations on CMake.
## Licenses
-Copyright (C) 2020-2023 [|Méso|Star>](http://www.meso-star.com)
-<contact@meso-star.com>. MruMtl is free software released under the GPL v3+
-license: GNU GPL version 3 or later. You are welcome to redistribute them under
-certain conditions; refer to the COPYING file for details.
+Copyright (C) 2020-2023 |Méso|Star> (contact@meso-star.com)
+
+MruMtl is free software released under the GPL v3+ license: GNU GPL version 3
+or later. You are welcome to redistribute them under certain conditions; refer
+to the COPYING file for details.
