summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPikalaxALT <pikalaxalt@gmail.com>2018-01-03 17:45:41 -0700
committerPikalaxALT <pikalaxalt@gmail.com>2018-01-03 17:45:41 -0700
commit66201fa6ab8f91fbebe24c6ea5904b5fb7c652f2 (patch)
treeeae14677599108bb60b8b6cd54605ba6e7159845
parenta6c1ed4716cf02626ea035beb6dd4a921642ba80 (diff)
add README.md and INSTALL.md
-rw-r--r--INSTALL.md27
-rw-r--r--README.md37
2 files changed, 64 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..b2440d2
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,27 @@
+# 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_PMD-RED_DIRECTORY
+ ${DEVKITARM}/bin/arm-none-eabi/ranlib PATH_OF_PMD-RED_DIRECTORY/tools/agbcc/lib/libgcc.a lib/libc.a
+
+Then in the pokeruby 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 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 0000000..424b53d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# Pokémon Mystery Dungeon: Red Rescue Team [![Build Status][travis-badge]][travis]
+
+This is a disassembly of Pokémon Mystery Dungeon: Red Rescue Team.
+
+It builds the following rom:
+
+* pmd_red.gba `md5: 2100cf6f17e12cd34f1513647dfa506b`
+
+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 Fire Red**][pokefirered]
+* Disassembly of [**Pokémon Ruby/Sapphire**][pokeruby]
+* Disassembly of [**Pokémon Emerald**][pokeemerald]
+* 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
+[pokefirered]: https://github.com/pret/pokefirered
+[pokeruby]: https://github.com/pret/pokeruby
+[pokeemerald]: https://github.com/pret/pokeemerald
+[Discord]: https://discord.gg/cJxDDVP
+[irc]: https://kiwiirc.com/client/irc.freenode.net/?#pret
+[travis]: https://travis-ci.org/pret/pokeruby
+[travis-badge]: https://travis-ci.org/pret/pokeruby.svg?branch=master