From 7c0792913b6654a03067ed6feb364c5b51badc8a Mon Sep 17 00:00:00 2001 From: Stephen Seo Date: Mon, 5 Oct 2020 16:13:35 +0900 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 1e79203..b0d872d 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ # Compiling +[Install rust](https://rust-lang.org) + `cargo build --release` # Running @@ -16,3 +18,19 @@ 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. + +There are some issues running in debug mode, so be sure to use the executable +built with `cargo build --release`, or run with `cargo run --release`. + +# About + +Game programmed with [neovim](https://github.com/neovim/neovim) in the [Rust +programming language](https://rust-lang.org), and uses the +[ggez](https://ggez.rs) Rust library. + +All audio created with [lmms](https://lmms.io). + +All images created with [gimp](https://gimp.org). + +Uses ClearSans font (licensed under the [Apache 2 +license](resources/clearsans-LICENSE-2.0.txt). -- 2.49.0