From 0e725860197287a0e04638ce756ca97d0b09e4bc Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Wed, 5 Apr 2023 03:08:47 -0700 Subject: [PATCH] model3d: add README Signed-off-by: Stephen Gutekanst --- libs/model3d/README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 libs/model3d/README.md diff --git a/libs/model3d/README.md b/libs/model3d/README.md new file mode 100644 index 00000000..5fba1b77 --- /dev/null +++ b/libs/model3d/README.md @@ -0,0 +1,27 @@ +# mach/model3d - model3D + +[Model3D](https://gitlab.com/bztsrc/model3d/) is an up-and-coming compact, featureful, universal model format that tries to address the shortcomings of existing formats (yes, including glTF - see [their rationale](https://gitlab.com/bztsrc/model3d/#rationale).) + +This repository provides Zig bindings, with the aim of a pure-Zig implementation eventually. + +This repository is a separate copy of the same library in the [main Mach repository](https://github.com/hexops/mach), and is automatically kept in sync, so that anyone can use this library in their own project if they like! + +## Experimental + +This is an _experimental_ Mach library, according to our [stability guarantees](https://machengine.org/next/docs/libs/): + +> Experimental libraries may have their APIs change without much notice, and you may have to look at recent changes in order to update your code. + +[Why this library is not declared stable yet](https://machengine.org/next/docs/libs/experimental/#model3d) + +## Join the community + +Join the Mach community [on Discord](https://discord.gg/XNG3NZgCqp) to discuss this project, ask questions, get help, etc. + +## Issues + +Issues are tracked in the [main Mach repository](https://github.com/hexops/mach/issues?q=is%3Aissue+is%3Aopen+label%3Amodel3d). + +## Contributing + +Contributions are very welcome. Pull requests must be sent to [the main repository](https://github.com/hexops/mach/tree/main/libs/model3d) to avoid some complex merge conflicts we'd get by accepting contributions in both repositories. Once the changes are merged there, they'll get sync'd to this repository automatically.