]> git.seodisparate.com - LudumDare47_StuckInALoop/commitdiff
Add README.md
authorStephen Seo <seo.disparate@gmail.com>
Sun, 4 Oct 2020 12:00:12 +0000 (21:00 +0900)
committerStephen Seo <seo.disparate@gmail.com>
Sun, 4 Oct 2020 12:00:12 +0000 (21:00 +0900)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
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.