add INSTALL file

jrrci · Sep 3, 2016 · 5af8ba5 · 5af8ba5
1 parent de1bee2
commit 5af8ba5
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 5 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -0,0 +1,13 @@
+First, you must put a Pokémon Emerald (US) ROM in the root directory of the repository and name it `base_emerald.gba`. It should have a SHA1 checksum of `f3ae088181bf583e55daf962a92bb46f4f1d07b7`. Then, follow the OS-specific instructions below.
+
+# Linux
+
+TBD
+
+# 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 pokeemerald directory.
+
+You can then build pokeemerald using "make" in the MSYS environment provided with devkitARM.
diff --git a/README.md b/README.md
@@ -1 +1,9 @@
-# pokeemerald
+# Pokémon Emerald
+
+This is a disassembly of Pokémon Emerald.
+
+It builds the following rom:
+
+* pokeemerald.gba `sha1: f3ae088181bf583e55daf962a92bb46f4f1d07b7`
+
+To set up the repository, see [**INSTALL.md**](INSTALL.md).
diff --git a/build.bat b/build.bat