commit 44e0aeb962133a7910d63773543ac06ff07b6c06
parent ccc1539f48939f472e65a75ce31e287a95f4b19c
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 29 Jun 2023 09:58:38 +0200
Rewrite the README file
Cleanup and small rewrite of the preview. Add a requirements section
that lists project dependencies, actually just RSys. And complete
rewrite of the installation procedure concerning the use of a POSIX
Makefile and no longer CMake as the first build system.
Diffstat:
| M | README.md | | | 33 | +++++++++++++++++---------------- |
1 file changed, 17 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
@@ -1,19 +1,19 @@
# Polygon
-This small C89 library triangulates simple polygons, i.e. polygons whose their
-non consecutive edges does not intersect. It relies on the ear-clipping variant
-of Xianshu Kong et al. presented in "The Graham Scan Triangulates Simple
-Polygons".
+Polygon is a C library that triangulates polygons whose nonconsecutive edges do
+not intersect. It implements a variation of the ear clipping algorithm of
+Xianshu Kong et al. featured in [The Graham Scan Triangulates Simple
+Polygons](https://doi.org/10.1016/0167-8655\(90\)90089-K)
-## How to build
+## Requirments
-The library uses [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/#tab-readme) package to build. It also
-depends on the [RSys](https://gitlab.com/vaplv/rsys/#tab-readme) library.
-First, install the RCMake package and the RSys library. Then, generate the
-project from the cmake/CMakeLists.txt file by appending the RCMake and RSys
-install directories to the `CMAKE_PREFIX_PATH` variable. The resulting project
-can be edited, built, tested and installed as any CMake project.
+To build Polygon, you need RSys header files and library.
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -33,7 +33,8 @@ Update the version of the RSys dependency to 0.6: replace the deprecated
## License
-Copyright (C) 2014-2017, 2021 Vincent Forest (vaplv@free.fr). Polygon is free
-software released under 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) 2014-2017, 2021 Vincent Forest (vaplv@free.fr)
+
+Polygon is free software released under 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.
