Add README

3 years ago · 0239d770d2
3 changed files with 30 additions and 1 deletions
--- a/README.md
+++ 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).
--- 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)
--- a/wasm/index.html
+++ b/wasm/index.html
@ -1,5 +1,6 @@
 <html>
  <head>
+    <title>Tales of Midgard</title>
    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
  </head>
  <body>
@ -11,4 +12,5 @@
      });
    </script>
  </body>
+  <footer>© 2021 Garrit Franke</footer>
 </html>