aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTed Yin <ted.sybil@gmail.com>2018-07-08 10:16:53 -0700
committerGitHub <noreply@github.com>2018-07-08 10:16:53 -0700
commita670aa49d9fa8d93444d21e7576ac228ca372d25 (patch)
tree5f0d27c06f34610f03f0d49c6e651263adbc4716
parent34595aa8d6eab32e5a7eff13f10a56005bb98d99 (diff)
add installation guide for OS X
-rw-r--r--README.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index f977005..9a52452 100644
--- a/README.rst
+++ b/README.rst
@@ -42,6 +42,9 @@ Guidelines
Build the Example Emulator
==========================
+GNU/Linux
+---------
+
::
# for Ubuntu
@@ -56,3 +59,20 @@ Build the Example Emulator
cd runes
cargo build --examples --release # build the binary
target/release/examples/runes --help # see the help message
+
+Mac OS X
+--------
+
+::
+
+ # install homebrew
+ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+ # install Xcode command line tools
+ xcode-select --install
+ # install SDL2
+ brew install sdl2
+ # rust up
+ curl https://sh.rustup.rs -sSf | sh
+ # build RuNES and enjoy
+ git clone https://github.com/Determinant/runes.git
+ cargo build --examples --release