pokecrystal-board/INSTALL.md

88 lines
2.0 KiB
Markdown
Raw Normal View History

2015-02-06 13:41:57 -08:00
# Linux
2015-02-06 13:41:57 -08:00
sudo apt-get install make gcc bison git python python-setuptools
2015-02-06 13:41:57 -08:00
git clone git://github.com/bentley/rgbds.git
cd rgbds
sudo make install
cd ..
2014-11-12 07:30:37 -08:00
2015-02-06 13:41:57 -08:00
git clone --recursive git://github.com/kanzure/pokecrystal.git
cd pokecrystal
2015-02-06 13:41:57 -08:00
To build **pokecrystal.gbc**:
make
2015-02-06 13:41:57 -08:00
# OS X
2012-06-02 13:27:24 -07:00
2015-02-06 13:41:57 -08:00
On 10.8 or earlier, download and install **Command Line Tools for Xcode**.
2012-06-02 13:27:24 -07:00
2015-02-06 13:41:57 -08:00
On 10.9 or later:
xcode-select --install
2015-02-06 13:41:57 -08:00
In the shell, run:
2012-06-02 13:27:24 -07:00
git clone git://github.com/bentley/rgbds.git
cd rgbds
sudo make install
cd ..
2012-06-02 13:27:24 -07:00
2015-02-06 13:41:57 -08:00
git clone --recursive git://github.com/kanzure/pokecrystal.git
cd pokecrystal
To build **pokecrystal.gbc**:
make
2015-02-06 13:41:57 -08:00
# Windows
2015-02-06 13:41:57 -08:00
To build on Windows, use [**Cygwin**](http://cygwin.com/install.html) (32-bit).
2013-06-25 19:03:48 -07:00
2015-02-06 13:41:57 -08:00
In the installer, select the following packages: `make` `git` `python` `python-setuptools` `gcc` `libsasl2` `ca-certificates`
2012-06-02 13:27:24 -07:00
2015-02-06 13:41:57 -08:00
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`.
2012-06-02 13:27:24 -07:00
2015-02-06 13:41:57 -08:00
In the **Cygwin terminal**:
2012-06-02 13:27:24 -07:00
2015-02-06 13:41:57 -08:00
git clone --recursive git://github.com/kanzure/pokecrystal.git
cd pokecrystal
2015-02-06 13:41:57 -08:00
To build:
2015-02-06 13:41:57 -08:00
make
2015-02-06 13:41:57 -08:00
# Vagrant
2015-02-06 13:41:57 -08:00
The simplest way to get pokecrystal to compile is to use Vagrant and
VirtualBox. Follow these steps:
2015-02-06 13:41:57 -08:00
* [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
```
2015-02-06 13:41:57 -08:00
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".
2015-02-06 13:41:57 -08:00
To build the project, run these commands in the guest (that is, inside "vagrant
ssh"):
2015-02-06 13:41:57 -08:00
cd /vagrant/pokecrystal
make