commit a902d102d2784ed7561a65c3161d8850918aa9e7
parent db3718242ab14b2dac2e5d336cff08a101443712
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 27 Jul 2023 15:11:12 +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 | | | 42 | ++++++++++++++++++++---------------------- |
1 file changed, 20 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
@@ -1,29 +1,27 @@
-# Star-ColorMap
+# Star Color Map
-This library maps a a real value to a color by interpolating between
-pre-defined support points defined in palettes. Several common palettes are
-provided by the library.
+This library maps a real value to a color by interpolating for a given value
+the colors predefined in a palette. A set of common palettes is integrated into
+the library; see the scmap.h header for a complete list.
-## How to build
+## Requirements
-Star-ColorMap 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.
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
-First ensure that CMake is installed on your system. Then install the RCMake
-package as well as the RSys prerequisite. 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
### Version 0.0.3
-Fix compilation warnings detected by gcc 11
+Fix compilation warnings detected by gcc 11
### Version 0.0.2
@@ -36,8 +34,8 @@ Fix MSVC build.
## License
-Copyright (C) 2020, 2021 [|Meso|Star>](https://www.meso-star.com)
-(<contact@meso-star.com>). Star-ColorMap 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.
+Copyright (C) 2020, 2021 |Meso|Star> (contact@meso-star.com)
+
+Star-CMap 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.
