From 10b8b90c2dccd69fb337df9fe8c263d9a5048f61 Mon Sep 17 00:00:00 2001
From: hut <hut@hut.pm>
Date: Sat, 30 Mar 2024 13:52:15 +0100
Subject: [PATCH] add MacOS build instructions

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 30b9235..5a981a2 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,7 @@ Key features:
 Workaround if you don't have a vulkan GPU: Enable the OpenGL rendering backend by setting the `WGPU_BACKEND` environment variable to `gl`, e.g. by running `WGPU_BACKEND=gl cargo run` or `WGPU_BACKEND=gl ./outfly`. Note that this has considerably slower performance and occasional visual glitches.
 
 # Building
+## On Linux
 
 To run the pre-compiled version on Arch Linux, you need some basic libs:
 
@@ -66,6 +67,23 @@ cargo build --target=x86_64-pc-windows-gnu --release
 
 More information here: https://bevy-cheatbook.github.io/setup/cross/linux-windows.html
 
+## Building on Mac OS
+
+Install homebrew, and then get the following dependencies:
+
+```
+brew install pkg-config molten-vk rustup
+rustup-init
+```
+
+Download, compile and run the game:
+
+```
+git clone [URL]
+cd outfly
+cargo run --release
+```
+
 # Credits
 
 - https://pixabay.com/sound-effects/typosonic-typing-192811