From 0239d770d28efac2294fbb88d075a4c7fc725bf0 Mon Sep 17 00:00:00 2001 From: Garrit Franke Date: Fri, 22 Jan 2021 16:33:26 +0100 Subject: [PATCH] Add README --- README.md | 27 +++++++++++++++++++++++++++ src/main.rs | 2 +- wasm/index.html | 2 ++ 3 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e35116e --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Legends of Midgard + +Legends of Midgard is a terminal-based rogue-like role playing game. + +## Building + +Rust and Cargo need to be installed to run this game. Then, simply run the following command: + +``` +cargo run +``` + +## Building for the web + +This game can be compiled to wasm, to be included on a website. +To do this, there's a `build_wasm.sh` file in the `contrib/` directory. +Execute it from the root of the project, then host the `wasm` directory with a web-server of your choice. + +``` +sh contrib/build_wasm.sh +cd wasm +python3 -m http.server +``` + +## License + +This game is licensed under [GPLv3](./LICENSE). diff --git a/src/main.rs b/src/main.rs index e85680c..19a4d1e 100644 --- a/src/main.rs +++ b/src/main.rs @@ -237,7 +237,7 @@ impl Algorithm2D for State { fn main() -> RltkError { let context = RltkBuilder::simple(80, 70)? - .with_title("Tales of Midgard") + .with_title("Legends of Midgard") .build()?; let gs = State::new(); rltk::main_loop(context, gs) diff --git a/wasm/index.html b/wasm/index.html index d23258e..99be9fe 100644 --- a/wasm/index.html +++ b/wasm/index.html @@ -1,5 +1,6 @@ + Tales of Midgard @@ -11,4 +12,5 @@ }); +