aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst13
1 files changed, 12 insertions, 1 deletions
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