search

gkjohnson / three-bvh-csg

A flexible, memory compact, fast and dynamic CSG implementation on top of three-mesh-bvh
MIT License
552 stars 45 forks source link

WIP: Update README.md #81

Closed AngyDev closed 1 year ago

AngyDev commented 1 year ago

Related issue: #72

I tried to add some documentation, I hope it's not a mess. It's not easy. The two classes PointsHelper and HalfEdgeHelper are not documented, I'm not sure about how to explain them.

Feel free to cancel the PR if the documentation is not consistent. I understand 😅

AngyDev commented 1 year ago

Added your suggestions. I think it's a start. I also corrected the types of the helper methods.

gkjohnson commented 1 year ago

This is excellent and a huge help - thank you again!