README: add new website, Matrix chat room
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst
Stephen Gutekanst
parent
595cf48450
commit
8b717318d9
1 changed files with 12 additions and 41 deletions
53
README.md
53
README.md
|
|
@ -1,25 +1,16 @@
|
||||||
<img alt="Mach - Game engine & graphics toolkit for the future" src="https://raw.githubusercontent.com/hexops/media/main/mach/logo_tagline_semi.svg"></img>
|
<a href="https://hexops.com/mach"><img alt="Mach - Game engine & graphics toolkit for the future" src="https://raw.githubusercontent.com/hexops/media/main/mach/logo_tagline_semi.svg"></img></a>
|
||||||
|
|
||||||
# Mach engine [](https://github.com/hexops/mach/actions) <a href="https://hexops.com"><img align="right" alt="Hexops logo" src="https://raw.githubusercontent.com/hexops/media/main/readme.svg"></img></a>
|
<h2 align="center">Learn more at <a href="https://hexops.com/mach">hexops.com/mach</a></h2>
|
||||||
|
|
||||||
## ⚠️ Project status: in-development ⚠️
|
## Join the conversation
|
||||||
|
|
||||||
Under heavy development, not ready for use currently. [Follow @machengine on Twitter](https://twitter.com/machengine) for updates.
|
Our community exists [on Matrix chat](https://matrix.to/#/#hexops:matrix.org), join in and help build the future of game engines & graphics in Zig!
|
||||||
|
|
||||||
## News
|
You can also follow [@machengine on Twitter](https://twitter.com/machengine) for updates.
|
||||||
|
|
||||||
You can read about major Mach engine developments at [devlog.hexops.com](https://devlog.hexops.com/categories/mach/):
|
## ⚠️ in-development ⚠️
|
||||||
|
|
||||||
* [Perfecting GLFW for Zig, and finding lurking undefined behavior that went unnoticed for 6+ years](https://devlog.hexops.com/2021/perfecting-glfw-for-zig-and-finding-undefined-behavior)
|
Under heavy development, not ready for use currently.
|
||||||
* [Mach engine: The future of graphics (with Zig)](https://devlog.hexops.com/2021/mach-engine-the-future-of-graphics-with-zig)
|
|
||||||
|
|
||||||
## Zero fuss installation & cross compilation
|
|
||||||
|
|
||||||
Mach is built from the ground up to support zero fuss installation & cross compilation, **only `zig` and `git` are needed to build from any OS and produce binaries for every platform.**
|
|
||||||
|
|
||||||
If you've ever worked with game engines in C, C++, Rust, Go, or any other language you've probably run into issues at one point getting the right system dependencies installed, whether it be library versions, compilers, system SDKs, X11/GLFW/SDL C dependencies, etc. With Mach, none of this is needed - it's all sorted out for you automagically.
|
|
||||||
|
|
||||||
Mach is able to do this thanks to Zig being a C/C++ compiler, Zig's linker `zld` supporting macOS cross compilation, and us doing the heavy lifting of packaging the required [system SDK libraries](https://github.com/hexops/sdk-macos-11.3) and [C sources](glfw/upstream/) for every dependency we need so our Zig build scripts can simply `git clone` them for you as needed for the target OS you're building for, completely automagically.
|
|
||||||
|
|
||||||
## Supported platforms
|
## Supported platforms
|
||||||
|
|
||||||
|
|
@ -39,7 +30,7 @@ Mach is still incredibly early stages, so far we have support for building from
|
||||||
* 🏃 Planned or in progress.
|
* 🏃 Planned or in progress.
|
||||||
* ⚠️ Implemented, but has known issues (e.g. bugs in Zig.)
|
* ⚠️ Implemented, but has known issues (e.g. bugs in Zig.)
|
||||||
|
|
||||||
## Libraries for all
|
## Subrepositories / projects
|
||||||
|
|
||||||
Whether you're interested in using all of Mach, or just some parts of it, you get to choose.
|
Whether you're interested in using all of Mach, or just some parts of it, you get to choose.
|
||||||
Our libraries all aim to have the same zero-fuss installation, cross compilation, and platform
|
Our libraries all aim to have the same zero-fuss installation, cross compilation, and platform
|
||||||
|
|
@ -47,31 +38,11 @@ support:
|
||||||
|
|
||||||
* [mach-glfw](https://github.com/hexops/mach-glfw): Ziggified GLFW bindings with 100% API coverage
|
* [mach-glfw](https://github.com/hexops/mach-glfw): Ziggified GLFW bindings with 100% API coverage
|
||||||
|
|
||||||
## About sub-repositories
|
## Contributing
|
||||||
|
|
||||||
In this repository, we maintain Mach as a monorepo. We pull in all commits from our library sub-repositories listed above using [`git subtree`](https://www.atlassian.com/git/tutorials/git-subtree):
|
Mach is maintained as a monorepo. When changed are merged to this repository, we use some git fu to pick out the commits to subdirectories and push them ot sub-repositories. For example, commits to the `glfw/` directory also get pushed to the separate [mach-glfw](https://github.com/hexops/mach-glfw) repository after being merged here.
|
||||||
|
|
||||||
```
|
|
||||||
git subtree pull --prefix glfw https://github.com/hexops/mach-glfw main
|
|
||||||
```
|
|
||||||
|
|
||||||
This pulls in all commits from our sub-repositories, and effectively leads to a full history of all Mach development across all core repositories.
|
|
||||||
|
|
||||||
Pull requests can be made to any repository (we synchronize both ways via `git subtree pull` and `git subtree push`.)
|
|
||||||
|
|
||||||
There are only two requirements:
|
There are only two requirements:
|
||||||
|
|
||||||
1. Pull requests in sub-repositories must have a commit message prefix, e.g. `glfw: <commit message>` to keep our monorepo history nicer - we generally squash merge pull requests so this is not an issue.
|
1. Pull requests to sub-repositories must be sent to this monorepo, not to the sub-repository itself - to avoid some annoying merge conflicts that can arise.
|
||||||
2. Pull requests to this repository may not change multiple sub-repositories in the same commit (e.g. a commit to `glfw/` should not also include changes to `webgpu/`, to avoid confusion.)
|
2. Individual commits may not change multiple sub-repositories at the same time (e.g. a commit to `glfw/` cannot also include changes to `gpu/`, to avoid confusion.)
|
||||||
|
|
||||||
## Sponsors
|
|
||||||
|
|
||||||
If you like Mach engine, or my other work, you may [sponsor me on GitHub](https://github.com/sponsors/slimsag). This will make my day, it's a huge vote of confidence and I really appreciate your support!
|
|
||||||
|
|
||||||
### Silver sponsors
|
|
||||||
|
|
||||||
<!-- silver --><a href="https://github.com/wilsonk"><img src="https://images.weserv.nl/?url=github.com/wilsonk.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/"><img src="https://images.weserv.nl/?url=github.com/.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><!-- silver -->
|
|
||||||
|
|
||||||
### Bronze sponsors
|
|
||||||
|
|
||||||
<!-- bronze --><a href="https://github.com/mattnite"><img src="https://images.weserv.nl/?url=github.com/mattnite.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/andrewrk"><img src="https://images.weserv.nl/?url=github.com/andrewrk.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/Luukdegram"><img src="https://images.weserv.nl/?url=github.com/Luukdegram.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/Jack-Ji"><img src="https://images.weserv.nl/?url=github.com/Jack-Ji.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/ZacxDev"><img src="https://images.weserv.nl/?url=github.com/ZacxDev.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/kristoff-it"><img src="https://images.weserv.nl/?url=github.com/kristoff-it.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/tauoverpi"><img src="https://images.weserv.nl/?url=github.com/tauoverpi.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/TommiSinivuo"><img src="https://images.weserv.nl/?url=github.com/TommiSinivuo.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/bradms"><img src="https://images.weserv.nl/?url=github.com/bradms.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/jayschwa"><img src="https://images.weserv.nl/?url=github.com/jayschwa.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/jamii"><img src="https://images.weserv.nl/?url=github.com/jamii.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/dawnarc"><img src="https://images.weserv.nl/?url=github.com/dawnarc.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/jacobsandlund"><img src="https://images.weserv.nl/?url=github.com/jacobsandlund.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><a href="https://github.com/jorangreef"><img src="https://images.weserv.nl/?url=github.com/jorangreef.png?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" width="60px" alt="" /></a><!-- bronze -->
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue