ref: 37f4f47aa8e6ee7fad2e27d3775009bafa24177f
parent: dee494304392bdb9504560438dc5374f0db5b906
author: yenatch <yenatch@gmail.com>
date: Sun Dec 8 11:02:25 EST 2013
add INSTALL.md and README -> README.md
--- /dev/null
+++ b/INSTALL.md
@@ -1,0 +1,55 @@
+# Getting Started
+
+A base rom of Pokémon Red is required to assemble **pokered.gbc**.
+
+ Pokemon Red (UE) [S][!].gb
+ (MD5: 3d45c1ee9abd5738df46d2bdda8b57dc)
+
+
+# Linux
+
+ sudo apt-get install make gcc bison git python python-setuptools
+ sudo easy_install pip
+
+Install rgbds, a Game Boy ROM assembler.
+
+ git clone git://github.com/bentley/rgbds.git
+ cd rgbds
+ make
+ sudo make install
+
+ cd ..
+
+Set up the pokered repository.
+
+ git clone git://github.com/iimarckus/pokered.git
+ cd pokered
+
+ git submodule init
+ git submodule update
+
+ cd extras
+ pip install -r requirements.txt
+ cd ..
+
+Put your base rom in the pokered repository. Name it "baserom.gbc".
+
+ make red
+
+This should take about 10-15 seconds. Subsequent compiles are faster.
+
+
+To build Pokémon Blue:
+
+ make blue
+
+
+# OSX
+
+Download and install Xcode. Then follow the Linux instructions.
+
+
+# Windows
+
+Not yet.
+
--- a/README
+++ /dev/null
@@ -1,19 +1,0 @@
-This is a disassembly of Pokémon Red.
-
-It uses the following ROM as a base:
-Pokemon Red (UE) [S][!].gb
-(MD5: 3d45c1ee9abd5738df46d2bdda8b57dc)
-
-To assemble, first install RGBDS and put it in your path.
-
-The version of RGBDS needed is rgbds-linux:
-https://github.com/bentley/rgbds/
-git://github.com/bentley/rgbds.git
-
-Then copy the Pokémon ROM to this directory as "baserom.gbc".
-Then run "make" in your shell.
-
-This will output a file named "pokered.gbc".
-
-Our IRC channel is located here:
-server nucleus.kafuka.org, channel #skeetendo
--- /dev/null
+++ b/README.md
@@ -1,0 +1,18 @@
+# Pokémon Red
+
+This is a disassembly of Pokémon Red.
+
+It uses the following ROM as a base:
+
+ Pokemon Red (UE) [S][!].gb
+ (MD5: 3d45c1ee9abd5738df46d2bdda8b57dc)
+
+To set up the repository, see [**INSTALL.md**](https://github.com/iimarckus/pokered/blob/master/INSTALL.md).
+
+
+## See also
+
+* Disassembly of [**Pokémon Crystal**](https://github.com/kanzure/pokecrystal)
+
+* irc: **nucleus.kafuka.org** [**#skeetendo**](https://kiwiirc.com/client/irc.nolimitzone.com/?#skeetendo)
+