diff --git a/INSTALL.md b/INSTALL.md index 065a649b9..8d52954c8 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,40 +1,77 @@ -# Getting Started - -Assembling **pokecrystal.gbc** requires a certain **Pokémon Crystal** rom: - - Pokemon - Crystal Version (UE) (V1.0) [C][!].gbc - md5: 9f2922b235a5eeb78d65594e82ef5dde - - # 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 **pokecrystal** repository: + git clone git://github.com/bentley/rgbds.git + cd rgbds + sudo mkdir -p /usr/local/man/man{1,7} + sudo make install + cd .. + +Set up the repository. git clone git://github.com/kanzure/pokecrystal.git cd pokecrystal + git submodule init + git submodule update + sudo pip install -r extras/requirements.txt - ./init.sh +- Copy your Pokémon Crystal rom to the directory. Name it **baserom.gbc**. -Copy the Pokémon Crystal rom to this directory. Name it **baserom.gbc**. - -Now you should be able to build **pokecrystal.gbc** for the first time. +To build **pokecrystal.gbc**: make -Your first build may take about 30 seconds. Subsequent builds are much faster (2-10 seconds). +This should take about 30 seconds. +Subsequent builds are much faster (2-10 seconds). -# OSX +# OS X -Download and install **Xcode**. Then follow the Linux instructions. +Download and install **Command Line Tools for Xcode**. +Then follow the Linux instructions. + +If you have Xcode already, you can get Command Line Tools with: + + xcode-select --install # Windows -Not yet. +It's recommended that you use a virtual machine running Linux or OS X. + +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 +* libsasl2 +* ca-certificates + +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/kanzure/pokecrystal.git + cd pokecrystal + git submodule init + git submodule update + sudo easy_install pip + sudo pip install -r extras/requirements.txt + +- Copy your Pokémon Crystal rom to the directory. Name it **baserom.gbc**. + +To build: + + make diff --git a/init.sh b/init.sh deleted file mode 100755 index 07f1aa244..000000000 --- a/init.sh +++ /dev/null @@ -1,21 +0,0 @@ -#!/bin/sh - -# install rgbds -git clone git://github.com/bentley/rgbds.git && \ -cd rgbds && \ -make && \ -mkdir -p /usr/local/man/man1 && \ -mkdir -p /usr/local/man/man7 && \ -sudo make install && \ -cd .. && \ -rm -rf rgbds - -# set up the submodule (extras/) -git submodule init && \ -git submodule update && \ -sudo easy_install pip && \ -sudo pip install -r extras/requirements.txt - -# diff binary files using hexdump -git config diff.hex.textconv "hexdump -C" -