From: Stephen Seo <seo.disparate@gmail.com>
Date: Sun, 4 Oct 2020 12:00:12 +0000 (+0900)
Subject: Add README.md
X-Git-Url: https://git.seodisparate.com/server_config?a=commitdiff_plain;h=35aced4cd69736b6bdb5ff6abcdad7c1825a7946;p=LudumDare47_StuckInALoop

Add README.md
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..35f13dd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Compiling
+
+`cargo build --release`
+
+# Running
+
+The `resources` directory needs to be in the same place as the executable.  
+This may cause `cargo run` to fail, as it doesn't move the resources directory.
+
+You will have to either move the executable to the root directory of this
+project, or make a symlink/copy of `resources` to the directory that holds the
+executable.