diff options
author | yenatch <yenatch@gmail.com> | 2015-02-06 13:41:57 -0800 |
---|---|---|
committer | yenatch <yenatch@gmail.com> | 2015-02-06 14:12:40 -0800 |
commit | 5e8112e305066957139e1e8b1e3151408e2917ac (patch) | |
tree | b5d35a174510ab648ed5c57a1d9005144d925fd4 | |
parent | f8acaf69f05a4086415cf6e156bd8f668a8eadda (diff) |
INSTALL: Use git clone --recursive.
-rw-r--r-- | INSTALL.md | 123 |
1 files changed, 54 insertions, 69 deletions
diff --git a/INSTALL.md b/INSTALL.md index 53cd30580..67ad45e28 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,112 +1,97 @@ -# Vagrant +# Linux -The simplest way to get pokecrystal to compile is to use Vagrant and -VirtualBox. Follow these steps: + sudo apt-get install make gcc bison git python python-setuptools -* [Download and install Vagrant](http://www.vagrantup.com/downloads.html) -* Follow the instructions to [download and install VirtualBox](http://docs-v1.vagrantup.com/v1/docs/getting-started/) -* Run these commands: + git clone git://github.com/bentley/rgbds.git + cd rgbds + sudo make install + cd .. -``` - vagrant box add pokecrystal http://diyhpl.us/~bryan/irc/pokecrystal/pokecrystal.box - mkdir vagrantbox - cd vagrantbox - vagrant init pokecrystal - vagrant up - vagrant ssh -c "cd /vagrant && git clone git://github.com/kanzure/pokecrystal.git" - vagrant ssh -c "cd /vagrant/pokecrystal && git submodule init && git submodule update" - vagrant ssh -``` + git clone --recursive git://github.com/kanzure/pokecrystal.git + cd pokecrystal -Running "vagrant ssh" will give you a shell to type commands into for compiling -the source code. The the "virtualbox" directory on the host appears as a shared -folder inside of the guest virtual machine at "/vagrant". +- Copy a Pokémon Crystal rom into `pokecrystal/`. Name it **baserom.gbc**. Eventually this will not be required. -To build the project, run these commands in the guest (that is, inside "vagrant -ssh"): +To build **pokecrystal.gbc**: - cd /vagrant/pokecrystal make -To make the build work you will need to copy baserom.gbc into the "pokecrystal" -directory inside the "virtualbox" directory on the host machine. Eventually -this will not be required. -# Linux +# OS X -Dependencies: +On 10.8 or earlier, download and install **Command Line Tools for Xcode**. - sudo apt-get install make gcc bison git python python-setuptools +On 10.9 or later: + + xcode-select --install -The assembler used is [**rgbds**](https://github.com/bentley/rgbds). +In the shell, run: 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 + git clone --recursive git://github.com/kanzure/pokecrystal.git cd pokecrystal - git submodule init - git submodule update - easy_install pypng - make pngs -- Copy your Pokémon Crystal rom into `pokecrystal/`. Name it **baserom.gbc**. +- Copy a Pokémon Crystal rom into `pokecrystal/`. Name it **baserom.gbc**. Eventually this will not be required. To build **pokecrystal.gbc**: make -This should take about 30 seconds. -Subsequent builds are much faster (2-10 seconds). +# Windows -# OS X +To build on Windows, use [**Cygwin**](http://cygwin.com/install.html) (32-bit). -Download and install **Command Line Tools for Xcode**. -Then follow the Linux instructions. +In the installer, select the following packages: `make` `git` `python` `python-setuptools` `gcc` `libsasl2` `ca-certificates` -If you have Xcode already, you can get Command Line Tools with: +Then get the most recent version of [**rgbds**](https://github.com/bentley/rgbds/releases/). +Put `rgbasm.exe`, `rgblink.exe` and `rgbfix.exe` in `C:\cygwin\usr\local\bin`. - xcode-select --install +In the **Cygwin terminal**: + git clone --recursive git://github.com/kanzure/pokecrystal.git + cd pokecrystal -# Windows +- Copy a Pokémon Crystal rom into `C:\cygwin\home\<username>\pokecrystal`. Name it **baserom.gbc**. Eventually this will not be required. -It's recommended that you use a virtual machine running Linux or OS X. +To build: -If you insist on Windows, use [**Cygwin**](http://cygwin.com/install.html) (32-bit). + make -Dependencies are downloaded in the installer rather than the command line. -Select the following packages: -* make -* git -* python -* python-setuptools -* gcc -* 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`. +# Vagrant -Then set up the repository. In the **Cygwin terminal**: +The simplest way to get pokecrystal to compile is to use Vagrant and +VirtualBox. Follow these steps: - git clone git://github.com/kanzure/pokecrystal.git - cd pokecrystal - git submodule init - git submodule update - easy_install pypng - make pngs +* [Download and install Vagrant](http://www.vagrantup.com/downloads.html) +* Follow the instructions to [download and install VirtualBox](http://docs-v1.vagrantup.com/v1/docs/getting-started/) +* Run these commands: + +``` + vagrant box add pokecrystal http://diyhpl.us/~bryan/irc/pokecrystal/pokecrystal.box + mkdir vagrantbox + cd vagrantbox + vagrant init pokecrystal + vagrant up + vagrant ssh -c "cd /vagrant && git clone --recursive git://github.com/kanzure/pokecrystal.git" + vagrant ssh +``` -- Copy your Pokémon Crystal rom into `C:\cygwin\home\<username>\pokecrystal`. Name it **baserom.gbc**. +Running "vagrant ssh" will give you a shell to type commands into for compiling +the source code. Then the "virtualbox" directory on the host appears as a shared +folder inside of the guest virtual machine at "/vagrant". -To build: +To build the project, run these commands in the guest (that is, inside "vagrant +ssh"): + cd /vagrant/pokecrystal make +To make the build work you will need to copy baserom.gbc into the "pokecrystal" +directory inside the "virtualbox" directory on the host machine. Eventually +this will not be required. |