Release version 3.0

pmp-library · Aug 24, 2023 · f2fb04f · f2fb04f
1 parent 171498a
commit f2fb04f
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 49 deletions.
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
@@ -1023,10 +1023,7 @@ RECURSIVE              = YES
 
 EXCLUDE                = ${CMAKE_SOURCE_DIR}/docs/issue_template.md \
                          ${CMAKE_SOURCE_DIR}/docs/pull_request_template.md \
-                         ${CMAKE_SOURCE_DIR}/docs/code_of_conduct.md \
-                         ${CMAKE_SOURCE_DIR}/docs/mpview.js \
-                         ${CMAKE_SOURCE_DIR}/docs/posts/version-3-released.md
-
+                         ${CMAKE_SOURCE_DIR}/docs/code_of_conduct.md
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
 # from the input.

diff --git a/docs/images/fandisk_quads.jpg b/docs/images/fandisk_quads.jpg
diff --git a/docs/news.md b/docs/news.md
@@ -1,5 +1,6 @@
 # News {#news}
 
+- @subpage version-3-0-released-2023-08-24 - Aug 24, 2023
 - @subpage version-2-0-1-released-2022-08-26 - Aug 26, 2022
 - @subpage version-2-0-released-2022-08-14 - Aug 14, 2022
 - @subpage pmp-at-sgp-2020-07-06 - Jul 06, 2020

diff --git a/docs/posts/2023-08-24-version-3.0-released.md b/docs/posts/2023-08-24-version-3.0-released.md
@@ -0,0 +1,46 @@
+# Version 3.0 Released {#version-3-0-released-2023-08-24}
+
+_Aug 24, 2023_
+
+![Smoothing and curvature computation on a quad mesh using a general polygon Laplacian.](/images/fandisk_quads.jpg)
+
+We are pleased to announce version 3.0 of the Polygon Mesh Processing Library! This is a major release with several additions and API changes. Highlights include:
+
+- We integrated a polygon Laplacian based on \cite bunge_2020_polygon . Several algorithms now work on general polygon meshes, including smoothing, parameterization, fairing, and curvature computation.
+- The geodesics in heat method based on \cite crane_2013_geodesics has been added.
+- The algorithms API has been revamped to use a simple function-based interface.
+- We no longer use git submodules for handling third-party dependencies.
+- Upgrade C++ standard to C++17
+- ... a whole lot of smaller fixes, cleanups, and improvements
+
+See the [changelog](https://github.com/pmp-library/pmp-library/blob/master/CHANGELOG.md) for a full summary of changes. Upgrading existing code from previous versions might require some changes due to the API rework we did. Please review the [changelog](https://github.com/pmp-library/pmp-library/blob/master/CHANGELOG.md) for any breaking changes that might affect you.
+
+## Obtaining PMP
+
+Get a copy by cloning:
+
+```sh
+git clone https://github.com/pmp-library/pmp-library.git
+```
+
+Checkout the 3.0 release tag:
+
+```sh
+cd pmp-library && git checkout 3.0
+```
+
+Configure and build:
+
+```sh
+mkdir build && cd build && cmake .. && make
+```
+
+Run the mesh processing app
+
+```sh
+./mpview ../data/off/bunny.off
+```
+
+## Reporting Bugs or Problems
+
+If you encounter any glitches or problems please [report the issue](https://github.com/pmp-library/pmp-library/issues) on GitHub.
diff --git a/docs/posts/version-3-released.md b/docs/posts/version-3-released.md