From e33956aea0531e50fd56cac5b99d35e32b55cd1b Mon Sep 17 00:00:00 2001 From: wo80 Date: Sat, 5 Mar 2022 23:07:04 +0100 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0932436..9ea49fe 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Triangle.NET -Triangle.NET generates 2D (constrained) Delaunay triangulations and high-quality meshes of point sets or planar straight line graphs. It is a C# port of Jonathan Shewchuk's [Triangle](https://www.cs.cmu.edu/~quake/triangle.html) software. +Triangle.NET generates 2D (constrained) Delaunay triangulations and high-quality meshes of point sets or planar straight line graphs. The code is based on Jonathan Richard Shewchuk's [Triangle](https://www.cs.cmu.edu/~quake/triangle.html) project, see references below. ## Features @@ -12,12 +12,17 @@ Triangle.NET generates 2D (constrained) Delaunay triangulations and high-quality * Node renumbering (Cuthill-McKee) * Read and write Triangle format files (.node, .poly, .ele) -## Usage - -Please refer to the [Examples](https://github.com/wo80/Triangle.NET/tree/master/src/Triangle.Examples) project. [Geri Borbás](https://github.com/Geri-Borbas) has prepared a "Release" branch containing the main project source only for submodule usage. +Until the wiki is setup, please refer to the [Examples](https://github.com/wo80/Triangle.NET/tree/master/src/Triangle.Examples) project to get started. ## License The original C code published by Jonathan Shewchuk comes with a proprietary license (see [Triangle README](https://github.com/wo80/Triangle/blob/master/src/Triangle/README)) which, unfortunately, isn't very clear about how a derived work like Triangle.NET should be handled. Though Triangle.NET was published on Codeplex (https://triangle.codeplex.com, no longer available) under the MIT license in 2012, I recommend not using this code in a commercial context. Due to the unclear licensing situation, there will also be no Nuget package release. For further discussion, please refer to the open issue [License Confusion](https://github.com/wo80/Triangle.NET/issues/6). + +## References + +If you want to learn about the algorithms used in Triangle.NET, I recommend taking a look at the following papers: +* Jonathan Richard Shewchuk, *Triangle: Engineering a 2D Quality Mesh Generator and Delaunay Triangulator* ([free PDF](https://duckduckgo.com/?t=ffsb&q=Triangle+Engineering+a+2D+Quality+Mesh+Generator+and+Delaunay+Triangulator&ia=web)) +* Jonathan Richard Shewchuk, *Delaunay Refinement Algorithms for Triangular Mesh Generation* ([free PDF](https://duckduckgo.com/?q=Delaunay+Refinement+Algorithms+for+Triangular+Mesh+Generation&t=ffsb&ia=web)) +* H. Erten & A. Üngör, *Triangulations with Locally Optimal Steiner Points* ([free PDF](https://duckduckgo.com/?t=ffsb&q=Triangulations+with+Locally+Optimal+Steiner+Points&ia=web))