diff options
| -rw-r--r-- | INSTALL.md | 28 | ||||
| -rw-r--r-- | README.md | 9 |
2 files changed, 37 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 000000000..796cd9eac --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,28 @@ +# Linux + +Install [**devkitARM**](http://devkitpro.org/wiki/Getting_Started/devkitARM) or compile [**GNU Binutils**](https://www.gnu.org/software/binutils/) with target "arm-none-eabi". + +Either way, 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-ld" and "arm-none-eabi-objcopy". + +For example, if you install binutils at "/usr/local", make DEVKITARM equal "/usr/local". + +Then get the compiler from https://github.com/YamaArashi/agbcc and run the following commands. + + build.sh + install.sh PATH_OF_POKERUBY_DIRECTORY + +Then in the pokeruby directory, build the tools. + + make tools + +Finally, build the rom. + + make + +# Windows + +Install [**devkitARM**](http://devkitpro.org/wiki/Getting_Started/devkitARM). + +Then get the compiled tools from https://github.com/YamaArashi/pokeruby-tools. Copy the "tools" folder over the "tools" folder in your pokeruby directory. + +You can then build pokeruby using "make" in the MSYS environment provided with devkitARM. diff --git a/README.md b/README.md new file mode 100644 index 000000000..10ad5f4c4 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Pokémon Ruby + +This is a disassembly of Pokémon Ruby. + +It builds the following rom: + +* pokeruby.gba `sha1: f28b6ffc97847e94a6c21a63cacf633ee5c8df1e` + +To set up the repository, see [**INSTALL.md**](INSTALL.md). |