From 6b886ee90581d343d5f41a40eac973b38da9b2d4 Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Sat, 11 Jun 2022 00:53:50 -0700 Subject: [PATCH] README: clean up / fix image width / dark theme --- README.md | 37 +++++++++++++++++-------------------- 1 file changed, 17 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 06e9090e..06d0aadc 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,11 @@ Written in [Zig](https://ziglang.org/), Mach is for creating games, graphical ap - Composable - Competitive with Unity and Unreal in spirit (a fully fledged editor in the future, etc.) -boids demo +example-advanced-gen-texture-light +example-boids +example-textured-cube + +[Example showcase](https://machengine.org/gpu/) ## Cross-platform graphics in ~60 seconds @@ -22,15 +26,22 @@ Cross-platform graphics, a unified shader language & compute shaders. (Requires [zig 0.10.x](https://ziglang.org/) | [known issues](https://github.com/hexops/mach/blob/main/doc/known-issues.md#known-issues)) - +## Libraries -## Join the conversation +Mach has many libraries you can use for game development in Zig - **you don't have to use the entire engine.** All our libraries aim to have the same zero-fuss installation, cross compilation, and platform support: -Join us [on Matrix chat](https://matrix.to/#/#hexops:matrix.org) in building the future of game engines & graphics in Zig! +- [mach-glfw](https://github.com/hexops/mach-glfw): Ziggified GLFW bindings with 100% API coverage +- [mach-freetype](https://github.com/hexops/mach-freetype): Ziggified Freetype 2 & HarfBuzz bindings +- [mach-gpu-dawn](https://github.com/hexops/mach-gpu-dawn): Google's Dawn WebGPU implementation, cross-compiled with Zig into a single static library +- [mach-system-sdk](https://github.com/hexops/mach-system-sdk): More libraries for cross-compilation with Zig -Follow [@machengine on Twitter](https://twitter.com/machengine) for updates. +## Join the community -Contributors are very welcome! There are lots of places you can help out with little knowledge, so feel free to reach out! +* [#hexops:matrix.org Matrix chat](https://matrix.to/#/#hexops:matrix.org), come discuss the future of game engines & graphics in Zig! +* [machengine.org](https://machengine.org) +* Follow [@machengine on Twitter](https://twitter.com/machengine) for updates. + +Contributors are very welcome! There are lots of places you can help out with little knowledge, so feel free to join the Matrix chat and say hi! ## Sponsor development @@ -40,12 +51,6 @@ No, it’s not Tom from myspace - it’s me, @slimsag! It’s taken [almost a ye There are few things in life that I am more serious about than this work. I dedicate ~48 hours/week to my dayjob, and ~50h/week to Zig building Mach and running [zigmonthly.org](https://zigmonthly.org). After three years of aggressively pushing for progress in this exact way, [I have no plans to slow down anytime soon.](https://devlog.hexops.com/2021/i-write-code-100-hours-a-week) -## Learn more & examples: [machengine.org](https://machengine.org) - -
- -
- ## Supported platforms Mach is still early stages, so far we have support for building from the following OS to the following targets: @@ -71,14 +76,6 @@ Mach targets Zig nightly, binary releases are available at https://ziglang.org/d Currently tested with: 0.10.0-dev.2439+c84f5a5f9 -## Libraries - -Mach has many libraries you can use for game development in Zig - you don't have to use the entire engine. All our libraries aim to have the same zero-fuss installation, cross compilation, and platform support: - -- [mach-glfw](https://github.com/hexops/mach-glfw): Ziggified GLFW bindings with 100% API coverage -- [mach-gpu-dawn](https://github.com/hexops/mach-gpu-dawn): Google's Dawn WebGPU implementation, cross-compiled with Zig into a single static library -- [mach-system-sdk](https://github.com/hexops/mach-system-sdk): More libraries for cross-compilation with Zig - ## Contributing Mach is maintained as a monorepo. When changes are merged to this repository, we use some git-fu to pick out the commits to subdirectories and push them to sub-repositories automagically. Changes to the `glfw/` directory in this repository get pushed to the separate [mach-glfw](https://github.com/hexops/mach-glfw) repository after being merged here, for example.