From 5279ba024771d8cb11b18b8ef22e6b1e9c78b2d6 Mon Sep 17 00:00:00 2001
From: RandomityGuy <31925790+RandomityGuy@users.noreply.github.com>
Date: Sun, 6 Jun 2021 10:54:32 +0530
Subject: [PATCH] Add readme

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..14b896e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# MBHaxe
+A Haxe port of Marble Blast Gold, name subject to change.
+
+# Build
+Requires Haxe 4.2.2  
+You require the latest versions of the following Haxe libraries: 
+- heaps  
+- polygonal-ds  (With https://github.com/polygonal/ds/pull/53 applied)  
+
+You also have to compile your own version of Hashlink with https://github.com/HaxeFoundation/hashlink/pull/444 applied  
+After all that has been setup, copy the data folder of MBG to the repo directory, compile to hashlink by doing `haxe compile.hxml` and then running the game by `hl marblegame.hl`
+