From 37f4f47aa8e6ee7fad2e27d3775009bafa24177f Mon Sep 17 00:00:00 2001
From: yenatch <yenatch@gmail.com>
Date: Sun, 8 Dec 2013 16:02:25 -0500
Subject: [PATCH] add INSTALL.md and README -> README.md

---
 INSTALL.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README     | 19 -------------------
 README.md  | 18 ++++++++++++++++++
 3 files changed, 73 insertions(+), 19 deletions(-)
 create mode 100644 INSTALL.md
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 00000000..b811a770
--- /dev/null
+++ b/INSTALL.md
@@ -0,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.
+
diff --git a/README b/README
deleted file mode 100644
index bdf5ac67..00000000
--- a/README
+++ /dev/null
@@ -1,19 +0,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
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..30c47e33
--- /dev/null
+++ b/README.md
@@ -0,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)
+