zig/mach
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

model3d: add README

Browse source 
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2023-04-05 03:08:47 -07:00
parent 8e01c4ba93
commit 0e72586019
1 changed files with 27 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

27
libs/model3d/README.md Normal file
View file

@ -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.