commit ecc96ddea066892b64fafe603dd6ecd27e1e0485
parent f9fbf68a33c51b1eb46389270e07e8024306b5a0
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 13 Sep 2023 16:43:04 +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 | | | 41 | ++++++++++++++++++----------------------- |
1 file changed, 18 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
@@ -1,26 +1,21 @@
# htpp
-This program is used to post process images saved in the
-[htrdr-image](https://gitlab.com/meso-star/htrdr/-/blob/master/doc/htrdr-image.5.scd)
-file format.
-
-## How to build
-
-This program 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. It also depends
-on the [RSys](https://gitlab.com/vaplv/rsys/) library and on the
-[OpenMP](http://www.openmp.org) 1.2 specification to parallelize its
-computations. It optionally depends on [scdoc](https://sr.ht/~sircmpwn/scdoc/)
-which, if available, is used to generate the htpp man page.
-
-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 tool post-processes images saved in htrdr-image format.
+
+## Requirements
+
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [Star Color Map](https://gitlab.com/meso-star/star-cmap)
+- [mandoc](https://mandoc.bsd.lv)
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -92,12 +87,12 @@ Fix a typo in the man page
## Copyright notice
-Copyright © 2018-2020, 2023 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>)
+Copyright © 2018-2020, 2023 |Méso|Star> (contact@meso-star.com)
Copyright © 2018, 2019 Centre National de la Recherche Scientifique
Copyright © 2018, 2019 Université Paul Sabatier
## License
-`htpp` is free software released under the GPL v3+ license: GNU GPL version 3
+htpp is free software released under the GPL v3+ license: GNU GPL version 3
or later. You are welcome to redistribute it under certain conditions; refer to
the COPYING file for details.
