commit 93512b81678a25a4ffc75fbb93237a13c8b9efde
parent 0d39d0bd834e44a4ad44e597a6f6f1afdf37aa1e
Author: vaplv <vaplv@free.fr>
Date: Mon, 22 Sep 2014 16:42:14 +0200
Add a README file
Diffstat:
1 file changed, 18 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# 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".
+
+## How to build
+
+The library uses [CMake](http://www.cmake.org) and the RCMake package to build.
+It also depends on the RSys library. First, install the RCMake package and the
+RSys library. Then, generate the project from the cmake/CMakeLists.txt file by
+appending the RCMake lib/cmake and RSys install directories to the
+`CMAKE_PREFIX_PATH` variable. The resulting project can be edited, built,
+tested and installed as any CMake project.
+
+Note that by default the library is built as a static library.
+
