Add an FAQ, and ive a bit more detail in Windows install instructions

This commit is contained in:
Remy Oukaour
2017-12-12 18:50:39 -05:00
parent 047c8e4bc0
commit f0ab091254
4 changed files with 54 additions and 13 deletions

View File

@@ -1,10 +1,12 @@
The source files are assembled into a rom using [**rgbds**](https://github.com/rednex/rgbds).
# Instructions
The source files are assembled into a ROM using [**rgbds**](https://github.com/rednex/rgbds).
These instructions explain how to set up the tools required to build.
If you run into trouble, ask for help on irc or discord (see [README.md](README.md)).
If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)).
# Linux
## Linux
```bash
sudo apt-get install make gcc bison git libpng-dev
@@ -25,7 +27,7 @@ make
```
# Mac
## Mac
In **Terminal**, run:
@@ -48,24 +50,23 @@ make
```
# Windows
## Windows
To build on Windows, install [**Cygwin**](http://cygwin.com/install.html) with the default settings.
Download [**Cygwin**](http://cygwin.com/install.html): **setup-x86_64.exe** for 64-bit Windows, **setup-x86.exe** for 32-bit.
Run setup and leave the default settings. At "Select Packages", choose to install the following:
In the installer, select the following packages:
- `make`
- `git`
- `gcc-core`
Then download [**rgbds**](https://github.com/rednex/rgbds/releases/).
Extract rgbds-0.3.3-win64.tar.gz and put all the `exe` and `dll` files individually in **C:\Cygwin64\usr\local\bin**. If you are using 32-bit Windows and Cygwin, extract **rgbds-0.3.3-win32.tar.gz** to **C:\Cygwin\usr\local\bin**.
Then download [**rgbds**](https://github.com/rednex/rgbds/releases/): the latest **win64.tar.gz** or **win32.tar.gz** release. Extract it and put all the `exe` and `dll` files individually in **C:\Cygwin64\usr\local\bin**.
**Note: If you have an older rgbds, you will need to update to 0.3.3 or newer.** Ignore this if you have never installed rgbds before.
In the **Cygwin terminal**:
In the **Cygwin terminal**, enter these commands:
```bash
git clone https://github.com/pret/pokecrystal
cd pokecrystal
```
@@ -75,3 +76,9 @@ To build **pokecrystal.gbc**:
```bash
make
```
To build **pokecrystal11.gbc**:
```bash
make crystal11
```