From a1c68771987ca6739deb1a271a887d117cd69e88 Mon Sep 17 00:00:00 2001 From: Maryanne Wachter Date: Sun, 2 Jun 2024 18:00:38 -0700 Subject: [PATCH] Add to readme.md, add dev status --- README.md | 10 +++++++++- pyproject.toml | 1 + 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bb9026f..7a93bd7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,10 @@ -# CyTriangle - A Python Wrapped Triangle Library via Cython +# CyTriangle +## A Python Wrapped Triangle Library via Cython +![ci-tests](https://github.com/m-clare/cytriangle/actions/workflows/ci.yaml/badge.svg) + +*CyTriangle* is an object-oriented python wrapper around Jonathan Richard Shewchuk's [Triangle](https://www.cs.cmu.edu/~quake/triangle.html) library. From its documentation: + +"Triangle generates exact Delaunay triangulations, constrained Delaunay triangulations, conforming Delaunay triangulations, Voronoi diagrams, and high-quality triangular meshes. The latter can be generated with no small or large angles, and are thus suitable for finite element analysis." + +*CyTriangle* utilizes Cython to provide an object-oriented interface to Triangle to enable easier inspection and modification of triangle objects. diff --git a/pyproject.toml b/pyproject.toml index a09011e..3119d0f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,6 +17,7 @@ keywords = [ "FEA" ] classifiers = [ + "Development Status :: 4 - Beta", "Environment :: Console", "Topic :: Scientific/Engineering", "Natural Language :: English",