add detailed setup guide

2 files changed, 13 insertions, 2 deletions

diff --git a/Cargo.lock b/Cargo.lock
index 7098de0..3c3f691 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -122,7 +122,7 @@ dependencies = [
 
 [[package]]
 name = "runes"
-version = "0.1.8"
+version = "0.1.9"
 dependencies = [
  "clap 2.29.2 (registry+https://github.com/rust-lang/crates.io-index)",
  "sdl2 0.31.0 (registry+https://github.com/rust-lang/crates.io-index)",
diff --git a/README.rst b/README.rst
index 4e19c9a..f977005 100644
--- a/README.rst
+++ b/README.rst
@@ -44,4 +44,15 @@ Build the Example Emulator
 
 ::
 
-    cargo build --examples --release    # (requires std, sdl2 and clap)
+    # for Ubuntu
+    # install Rust toolchain (https://www.rustup.rs/):
+    # $ sudo apt install curl gcc
+    # $ curl https://sh.rustup.rs -sSf | sh
+    # and add $HOME/.cargo/bin to your $PATH
+    # install SDL2 by:
+    # $ sudo apt install libsdl2-dev        # install SDL2 library
+
+    git clone https://github.com/Determinant/runes.git
+    cd runes
+    cargo build --examples --release        # build the binary
+    target/release/examples/runes --help    # see the help message