summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlibjet <libj3t@gmail.com>2021-01-21 14:13:14 +0000
committerhuderlem <huderlem@gmail.com>2021-01-21 12:17:13 -0600
commit9f755164ec5990bba8daed72ef05c689edf61b77 (patch)
treef1d2f477aa8847c87b69e6c54da721b70dda4dba
parent49c014f3dd2f4cee1a5e4fdd3801f0df8b4e709a (diff)
Refresh build instructions
-rw-r--r--INSTALL.md85
-rw-r--r--README.md28
2 files changed, 70 insertions, 43 deletions
diff --git a/INSTALL.md b/INSTALL.md
index eda9f04..318781b 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,49 +1,50 @@
-# Linux
+# Instructions
-Dependencies:
+These instructions explain how to set up the tools required to build **pokepinball**, including [**rgbds**](https://github.com/gbdev/rgbds), which assembles the source files into a ROM.
- sudo apt-get install make gcc bison git
- sudo easy_install pip
+If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)).
-The assembler used is [**rgbds**](https://github.com/bentley/rgbds) version [0.4.0](https://github.com/rednex/rgbds/releases/tag/v0.4.0).
+## Linux
- git clone https://github.com/rednex/rgbds
- cd rgbds
- sudo mkdir -p /usr/local/man/man{1,7}
- sudo make install
- cd ..
- rm -rf rgbds
+Open **Terminal** and enter the following commands, depending on which distro you're using.
-Set up the repository.
+### Debian or Ubuntu
- git clone https://github.com/huderlem/pokepinball
- cd pokepinball
+To install the software required for **pokepinball**:
-To build `pokepinball.gbc`:
+```bash
+sudo apt-get install make gcc git
+```
- make
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.4.2** from source.
-This will take a few seconds the first time you build because it needs to process all of the graphics.
+After that, you're ready to [build **pokepinball**](#build-pokepinball).
-To remove all generated files by the build process:
+### Arch Linux
+
+To install the software required for **pokepinball**:
+
+```bash
+sudo pacman -S make gcc git rgbds
+```
- make clean
+Now you're ready to [build **pokepinball**](#build-pokepinball).
-To compare the built `pokepinball.gbc` to the original ROM:
+If you want to compile and install **rgbds** yourself instead, then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.4.2** from source.
- make compare
+## macOS
-# OS X
+Install [**Homebrew**](https://brew.sh/). Follow the official instructions.
-In the shell, run:
+Open **Terminal** and prepare to enter commands.
- xcode-select --install
+Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/macos) for macOS to install **rgbds 0.4.2**.
-Then follow the Linux instructions.
+Now you're ready to [build **pokepinball**](#build-pokepinball).
-# Windows
+## Windows
To build on Windows, install [**Cygwin**](http://cygwin.com/install.html) with the default settings.
@@ -53,13 +54,33 @@ Select the following packages:
* git
* gcc-core
-The latest pokepinball-compatible version of **rgbds** is [**0.4.0**](https://github.com/rednex/rgbds/releases/tag/v0.4.0). To install, put each of the files in the download in `C:\cygwin\usr\local\bin`.
+The latest pokepinball-compatible version of **rgbds** is [**0.4.2**](https://github.com/gbdev/rgbds/releases/tag/v0.4.2). To install, put each of the files in the download in `C:\cygwin\usr\local\bin`.
+
+Now you're ready to [build **pokepinball**](#build-pokepinball).
+
+## Build pokepinball
-Then set up the repository. In the **Cygwin terminal**:
+To download the **pokepinball** source files:
+
+```bash
+git clone https://github.com/pret/pokepinball
+cd pokepinball
+```
+
+To build **pokepinball.gbc**:
+
+```bash
+make
+```
+
+To remove all generated files by the build process:
- git clone https://github.com/pret/pokepinball.git
- cd pokepinball
+```bash
+make clean
+```
-To build `pokepinball.gbc`:
+To compare the built **pokepinball.gbc** to the original ROM:
- make
+```bash
+make compare
+```
diff --git a/README.md b/README.md
index e205ae2..b3c3d92 100644
--- a/README.md
+++ b/README.md
@@ -11,16 +11,19 @@ To set up the repository, see [**INSTALL.md**](INSTALL.md).
## See also
-* Disassembly of [**Pokémon Red/Blue**][pokered]
-* Disassembly of [**Pokémon Yellow**][pokeyellow]
-* Disassembly of [**Pokémon Gold**][pokegold]
-* Disassembly of [**Pokémon Crystal**][pokecrystal]
-* Disassembly of [**Pokémon TCG**][poketcg]
-* Disassembly of [**Pokémon Ruby**][pokeruby]
-* Disassembly of [**Pokémon Fire Red**][pokefirered]
-* Disassembly of [**Pokémon Emerald**][pokeemerald]
-* Discord: [**pret**][Discord]
-* irc: **irc.freenode.net** [**#pret**][irc]
+- **Discord:** [pret][discord]
+- **IRC:** [freenode#pret][irc]
+
+Other disassembly projects:
+
+- [**Pokémon Red/Blue**][pokered]
+- [**Pokémon Yellow**][pokeyellow]
+- [**Pokémon Gold/Silver**][pokegold]
+- [**Pokémon Crystal**][pokecrystal]
+- [**Pokémon TCG**][poketcg]
+- [**Pokémon Ruby**][pokeruby]
+- [**Pokémon FireRed**][pokefirered]
+- [**Pokémon Emerald**][pokeemerald]
[pokered]: https://github.com/pret/pokered
[pokeyellow]: https://github.com/pret/pokeyellow
@@ -30,5 +33,8 @@ To set up the repository, see [**INSTALL.md**](INSTALL.md).
[pokeruby]: https://github.com/pret/pokeruby
[pokefirered]: https://github.com/pret/pokefirered
[pokeemerald]: https://github.com/pret/pokeemerald
-[Discord]: https://discord.gg/d5dubZ3
+[docs]: https://pret.github.io/pokecrystal/
+[wiki]: https://github.com/pret/pokecrystal/wiki
+[tutorials]: https://github.com/pret/pokecrystal/wiki/Tutorials
+[discord]: https://discord.gg/d5dubZ3
[irc]: https://kiwiirc.com/client/irc.freenode.net/?#pret