summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryenatch <yenatch@gmail.com>2014-02-13 22:34:52 -0500
committeryenatch <yenatch@gmail.com>2014-02-13 22:34:52 -0500
commit43342f1376693c0aefbec565bd9f36ef47484a0e (patch)
treee2e15c8a3f5eb0cb7ea2fef3203eb990de132927
parent8f1b7acd3c48e18c311608c13cebbcb5c8ce18c0 (diff)
Rewrite the install instructions without init.sh.
Cygwin instructions return.
-rw-r--r--INSTALL.md55
1 files changed, 44 insertions, 11 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 4dc213ab..d5e93818 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,36 +1,69 @@
# Linux
-Linux dependencies. OSX users already have these after installing Xcode.
+Dependencies:
sudo apt-get install make gcc bison git python python-setuptools
+ sudo easy_install pip
+The assembler used is [**rgbds**](https://github.com/bentley/rgbds).
-Set up the **pokered** repository:
+ git clone git://github.com/bentley/rgbds.git
+ cd rgbds
+ sudo mkdir -p /usr/local/man/man{1,7}
+ sudo make install
+ cd ..
+ rm -rf rgbds
+
+Set up the repository.
git clone git://github.com/iimarckus/pokered.git
cd pokered
+ git submodule init
+ git submodule update
+ sudo pip install -r extras/requirements.txt
+
+To build **pokered.gbc** and **pokeblue.gbc**:
- sudo ./init.sh
+ make
+This should take about 10 seconds. Subsequent builds are faster.
-Now **pokered.gbc** can be built from source.
+To build them individually:
make red
+ make blue
-This should take about 10-15 seconds. Subsequent builds are faster.
+# OS X
-To build **pokeblue.gbc**:
+Download and install **Xcode**. Then open a terminal and follow the Linux instructions.
- make blue
+# Windows
-# OSX
+It's recommended that you use a virtual machine running Linux or OS X.
-Download and install **Xcode**. Then follow the Linux instructions.
+If you insist on Windows, use [**Cygwin**](http://cygwin.com/install.html) (32-bit).
+Dependencies are downloaded in the installer rather than the command line.
+Select the following packages:
+* make
+* git
+* python
+* python-setuptools
-# Windows
+To install rgbds, extract the contents of **http://iimarck.us/etc/rgbds.zip** and put them in `C:\cygwin\usr\local\bin`.
+
+Then set up the repository. In the **Cygwin terminal**:
+
+ git clone git://github.com/iimarckus/pokered.git
+ cd pokered
+ git submodule init
+ git submodule update
+ sudo easy_install pip
+ sudo pip install -r extras/requirements.txt
+
+To build:
-Not yet.
+ make