summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcus Huderle <huderlem@gmail.com>2018-10-13 15:59:12 -0500
committerMarcus Huderle <huderlem@gmail.com>2018-10-13 15:59:12 -0500
commitecf4a06e944460dcf16c157cec7d73e7fd87cc3d (patch)
tree98c2c0183fa38328901cd27209835af777fa7a33
parentc4fc85ce9e843e419ef9e3c1c2f888529c7e40d8 (diff)
Add misc repo files
-rwxr-xr-x.gitattributes17
-rwxr-xr-xINSTALL.md96
-rwxr-xr-xREADME.md36
3 files changed, 149 insertions, 0 deletions
diff --git a/.gitattributes b/.gitattributes
new file mode 100755
index 0000000..96c1c12
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,17 @@
+*.pal text eol=crlf
+
+*.s text eol=lf
+*.txt text eol=lf
+Makefile text eol=lf
+*.mk text eol=lf
+*.c text eol=lf
+*.h text eol=lf
+*.pl text eol=lf
+*.inc text eol=lf
+*.sha1 text eol=lf
+
+*.png binary
+*.bin binary
+
+*.h linguist-language=C
+*.inc linguist-language=Assembly
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100755
index 0000000..37babc4
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,96 @@
+Follow the OS-specific instructions below.
+
+# Linux
+
+Install [**devkitARM**](http://devkitpro.org/wiki/Getting_Started/devkitARM).
+
+Make sure that there is an environment variable called DEVKITARM with the path of the directory before the "bin" directory containing "arm-none-eabi-as", "arm-none-eabi-cpp", "arm-none-eabi-ld" and "arm-none-eabi-objcopy".
+
+Then get the compiler from https://github.com/pret/agbcc and run the following commands.
+
+```
+./build.sh
+./install.sh PATH_OF_POKEPINBALLRS_DIRECTORY
+```
+
+Then in the pokepinballrs directory, build the tools.
+
+```
+./build_tools.sh
+```
+
+Finally, build the rom.
+
+```
+make
+```
+
+# Windows
+
+Install [**devkitARM**](http://devkitpro.org/wiki/Getting_Started/devkitARM).
+
+Then get the compiled tools from https://github.com/pret/pokeruby-tools. Copy the `tools/` folder over the `tools/` folder in your pokepinballrs directory.
+
+You can then build pokepinballrs using `make` in the MSYS environment provided with devkitARM.
+
+# Mac
+
+Installing pokepinballrs on a Mac requires macOS >= 10.12 (Sierra or higher).
+
+Download a [devkitPRO pacman](https://github.com/devkitPro/pacman/releases/tag/v1.0.0)
+
+Run the following commands in Terminal:
+
+
+```
+xcode-select --install
+
+sudo dkp-pacman -S devkitARM
+
+export DEVKITPRO=/opt/devkitpro
+echo "export DEVKITPRO=$DEVKITPRO" >> ~/.bashrc
+export DEVKITARM=$DEVKITPRO/devkitARM
+echo "export DEVKITARM=$DEVKITARM" >> ~/.bashrc
+echo "if [ -f ~/.bashrc ]; then . ~/.bashrc; fi" >> ~/.bash_profile
+
+git clone https://github.com/huderlem/pokepinballrs
+git clone https://github.com/pret/agbcc
+
+cd agbcc/
+./build.sh
+./install.sh ../pokepinballrs
+
+cd ../pokepinballrs
+./build_tools.sh
+```
+
+And build the ROM with `make`.
+
+# Faster builds
+
+After the first build, subsequent builds are faster. You can further speed up the build:
+
+## Parallel build
+
+This significantly speeds up the build on modern machines.
+
+By default `make` only runs a single thread. You can tell `make` to run on multiple threads with `make -j`. See the manfile for usage (`man make`).
+
+The optimal value for `-j` is the number of logical cores on your machine. You can run `nproc` to see the exact number.
+
+```
+$ nproc
+8
+```
+
+If you have 8 cores, run: `make -j8`
+
+`-j` on its own will spawn a new thread for each job. A clean build will have thousands of jobs, which will be slower than not using -j at all.
+
+## Disable the dependency scanning
+
+If you've 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 NODEP=1`
+
+
diff --git a/README.md b/README.md
new file mode 100755
index 0000000..fe7724e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Pokémon Pinball: Ruby & Sapphire
+
+This is a disassembly of Pokémon Pinball: Ruby & Sapphire.
+
+It builds the following rom:
+
+* pokepinballrs.gba `sha1: 9fec81ce2c5df589e0371a0bf2f92a5fe8db730b`
+
+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 Pinball**][pokepinball]
+* Disassembly of [**Pokémon TCG**][poketcg]
+* Disassembly of [**Pokémon Ruby**][pokeruby]
+* Disassembly of [**Pokémon Emerald**][pokeemerald]
+* Disassembly of [**Pokémon Fire Red**][pokefirered]
+* Discord: [**pret**][Discord]
+* irc: **irc.freenode.net** [**#pret**][irc]
+
+[pokered]: https://github.com/pret/pokered
+[pokeyellow]: https://github.com/pret/pokeyellow
+[pokegold]: https://github.com/pret/pokegold
+[pokecrystal]: https://github.com/pret/pokecrystal
+[pokepinball]: https://github.com/pret/pokepinball
+[poketcg]: https://github.com/pret/poketcg
+[pokeruby]: https://github.com/pret/pokeruby
+[pokeruby]: https://github.com/pret/pokeemerald
+[pokefirered]: https://github.com/pret/pokefirered
+[Discord]: https://discord.gg/vdTW48Q
+[irc]: https://kiwiirc.com/client/irc.freenode.net/?#pret