Update Readme #1025
Update Readme #1025
Conversation
| | TS/JS | npm | [manifold-3d](https://www.npmjs.com/package/manifold-3d) | internal | | ||
| | Python | PyPI | [manifold3d](https://pypi.org/project/manifold3d/) | internal | | ||
| | Java | N/A | [manifold](https://github.com/SovereignShop/manifold) | external | | ||
| | Clojure | N/A | [clj-manifold3d](https://github.com/SovereignShop/clj-manifold3d) | external | |
There was a problem hiding this comment.
Should we be using github url for all external bindings?
There was a problem hiding this comment.
No, I only use the Github link when there's nothing else. I think a project looks more legit if it has a separate documentation page or better yet if an official package manager lists it, so I use those when I can. They all link back to their githubs anyway.
| | [`Clipper2`](https://github.com/AngusJohnson/Clipper2) | `MANIFOLD_CROSS_SECTION=ON` | 2D: [`CrossSection`](https://manifoldcad.org/docs/html/classmanifold_1_1_cross_section.html) | | ||
| | [`Assimp`](https://github.com/assimp/assimp) | `MANIFOLD_EXPORT=ON` | Basic Mesh I/O | | ||
| | [`Nanobind`](https://github.com/wjakob/nanobind) | `MANIFOLD_PYBIND=ON` | Python bindings | | ||
| | [`Emscripten`](https://github.com/emscripten-core/emscripten) | `MANIFOLD_JSBIND=ON` | JS bindings via WASM | |
There was a problem hiding this comment.
I feel like we can just say emscripten is the build system for js bindings, because users can't use this in a normal build, unlike the other dependencies.
There was a problem hiding this comment.
I suppose - really I was thinking of Embind, which we're using a bit like Nanobind, but I think Embind is just part of emscipten like its own STL. The idea was just to list anything that might break if its version updates, which seems a lot more likely for emscripten than for clang.
README.md
Outdated
| - `MANIFOLD_CROSS_SECTION=[OFF, <ON>]`: Build CrossSection for 2D support (needed by language bindings), requires `Clipper2` if enabled. | ||
| - `MANIFOLD_EXPORT=[<OFF>, ON]`: Enables GLB export of 3D models from the tests, requires `libassimp-dev`. | ||
| - `MANIFOLD_EXPORT=[<OFF>, ON]`: Enables `MeshIO` and GLB export of 3D models from the tests, requires `libassimp-dev`. |
Addresses 1-6 of #1024 (comment) (not sure what to do for 7-9) and added lots of links to users and packages of Manifold.