Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
artem-ogre committed Jul 4, 2022
1 parent ad263e5 commit cc8d4a8
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,22 @@
***If CDT helped you please consider adding a star on GitHub. This means a lot to the authors*** 🤩

# CDT: Conforming or Constrained Delaunay Triangulation
## What is CDT?

## Table of Contents
- [What is CDT?](#"what-is-cdt)
- [What can CDT do?](#what-can-cdt-do)
- [Properly Handling the Corner-Cases](#corner-cases)
- [Online Documentation](#online-doc)
- [Algorithm](#algorithm)
- [Implementation Details](#details)
- [Installation/Building](#installation)
- [Using with Code Examples](#using)
- [Contributors](#contributors)
- [Contributing](#contributing)
- [Example Gallery](#example-gallery)
- [Bibliography](#bibliography)

## <a name="what-is-cdt"/>What is CDT?</a>
CDT is a C++ library for generating constraint or conforming Delaunay triangulations.
- **open-source:** permissively-licensed under Mozilla Public License (MPL) 2.0
- **cross-platform:** tested on Windows, Linux (Ubuntu), and macOS
Expand All @@ -15,34 +30,22 @@ CDT is a C++ library for generating constraint or conforming Delaunay triangulat
- **performant:** continuously profiled, measured, and optimized
- **numerically robust:** triantulation algorithms rely on robust geometric predicates

## What can CDT do?
<img src="./images/show-case.png" alt="CDT Logo" height="150"/>
## <a name="what-can-cdt-do"/>What can CDT do?</a>
<img src="./images/show-case.png" alt="CDT show-case: constrained and conforming triangulations, convex hulls, automatically removing holes" height="150"/>

- Constrained Delaunay Triangulations: force edges into Delaunay triangulation
- Conforming Delaunay Triangulations: add new points into Delaunay triangulation until the edge is present in triangulation
- Convex-hulls
- Automatically finding and removing holes

## What corner-cases can CDT handle?
<img src="./images/corner-cases.png" alt="CDT Logo" height="180"/>
## <a name="corner-cases"/>Properly Handling the Corner-Cases</a>
<img src="./images/corner-cases.png" alt="CDT supported corner cases: points on edges, overlapping edges, resolving edge intersections" height="180"/>

- Points exactly on the edges
- Exactly overlapping edges
- Resolving intersecting edges by adding points at the intersections (with `CDT::IntersectingConstraintEdges::Resolve`)



**Table of Contents**
- [Online Documentation](#online-doc)
- [Algorithm](#algorithm)
- [Implementation Details](#details)
- [Installation/Building](#installation)
- [Using with Code Examples](#using)
- [Contributors](#contributors)
- [Contributing](#contributing)
- [Example Gallery](#example-gallery)
- [Bibliography](#bibliography)

## <a name="online-doc"/>Online Documentation</a>
[**Latest online documentation**](https://artem-ogre.github.io/CDT/doxygen/index.html) (automatically generated with Doxygen).

Expand Down

0 comments on commit cc8d4a8

Please sign in to comment.