Merge pull request #8 from SatoMew/master

Installation instructions and minor documentation fixes
2018-10-03 08:27:51 -05:00
parent 232e64a597 1133410b3f
commit 4880b33ff2
3 changed files with 67 additions and 6 deletions
@@ -0,0 +1,52 @@
+Install [devkitARM](https://devkitpro.org/wiki/Getting_Started) (if you are on **Windows 10**, [do this instead](#windows-10)).
+
+Run the following commands (first, see [this](#macos) if you are on **macOS** or [this](#old-windows) if you are on **old Windows**):
+
+	export DEVKITPRO=/opt/devkitpro
+	echo "export DEVKITPRO=$DEVKITPRO" >> ~/.bashrc
+	export DEVKITARM=$DEVKITPRO/devkitARM
+	echo "export DEVKITARM=$DEVKITARM" >> ~/.bashrc
+
+	git clone https://github.com/pret/pokefirered
+	git clone https://github.com/pret/agbcc
+
+	cd agbcc
+	./build.sh
+	./install.sh ../pokefirered
+
+	cd ../pokefirered
+
+To build **pokefirered.gba**:
+
+	make -j$(nproc)
+
+If you have only changed `.c` or `.s` files, you can turn off the dependency scanning temporarily. Changes to any other files will be ignored, and the build will either fail or not reflect those changes.
+
+	make -j$(nproc) NODEP=1
+
+
+## macOS
+
+Run `xcode-select --install` in Terminal, then proceed by executing the commands.
+
+
+## Old Windows
+
+*For Windows 8.1 and earlier*
+
+Download and run the [Cygwin](https://www.cygwin.com/install.html) setup, leaving the default settings intact. At "Select Packages", set the view to "Full" and choose to install the following:
+
+- `make`
+- `git`
+- `gcc-core`
+- `gcc-g++`
+- `libpng-devel`
+
+In the Cygwin command prompt, enter the commands.
+
+If the command for building pokefirered.gba does not work, run `nproc` and use that value instead of `$(nproc)` for `make`.
+
+
+## Windows 10
+
+Install the [Windows Subsystem for Linux](https://docs.microsoft.com/windows/wsl/install-win10), then install [devkitARM](https://devkitpro.org/wiki/Getting_Started) inside the subsystem, and run the commands.
@@ -1,8 +1,8 @@
-# Pokémon Fire Red
+# Pokémon FireRed and LeafGreen

-This is a disassembly of Pokémon Fire Red.
+This is a disassembly of Pokémon FireRed and LeafGreen.

-It builds the following rom:
+It builds the following ROM:

 * pokefirered.gba `sha1: 41cb23d8dccc8ebd7c649cd8fbb58eeace6e2fdc`

@@ -11,13 +11,13 @@ To set up the repository, see [**INSTALL.md**](INSTALL.md).

 ## See also

-* Disassembly of [**Pokémon Red/Blue**][pokered]
+* Disassembly of [**Pokémon Red and Blue**][pokered]
 * Disassembly of [**Pokémon Yellow**][pokeyellow]
-* Disassembly of [**Pokémon Gold**][pokegold]
+* Disassembly of [**Pokémon Gold and Silver**][pokegold]
 * Disassembly of [**Pokémon Crystal**][pokecrystal]
 * Disassembly of [**Pokémon Pinball**][pokepinball]
 * Disassembly of [**Pokémon TCG**][poketcg]
-* Disassembly of [**Pokémon Ruby**][pokeruby]
+* Disassembly of [**Pokémon Ruby and Sapphire**][pokeruby]
 * Disassembly of [**Pokémon Emerald**][pokeemerald]
 * Discord: [**pret**][Discord]
 * irc: **irc.freenode.net** [**#pret**][irc]
@@ -0,0 +1,9 @@
+#!/bin/sh
+make -C tools/aif2pcm CXX=${1:-g++}
+make -C tools/bin2c CXX=${1:-g++}
+make -C tools/gbafix CXX=${1:-g++}
+make -C tools/gbagfx CXX=${1:-g++}
+make -C tools/preproc CXX=${1:-g++}
+make -C tools/ramscrgen CXX=${1:-g++}
+make -C tools/rsfont CXX=${1:-g++}
+make -C tools/scaninc CXX=${1:-g++}