aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authoryenatch <yenatch@gmail.com>2013-12-08 16:02:25 -0500
committeryenatch <yenatch@gmail.com>2013-12-08 16:02:25 -0500
commit37f4f47aa8e6ee7fad2e27d3775009bafa24177f (patch)
tree1e1a05ee49c2142d9ecb4f125292b1013268a8b5 /README
parentfinish off wram labels and fix up mistaken label overloads (diff)
downloadpokeyellow-37f4f47aa8e6ee7fad2e27d3775009bafa24177f.tar.gz
pokeyellow-37f4f47aa8e6ee7fad2e27d3775009bafa24177f.tar.xz
pokeyellow-37f4f47aa8e6ee7fad2e27d3775009bafa24177f.zip
add INSTALL.md and README -> README.md
Diffstat (limited to '')
-rw-r--r--README19
-rw-r--r--README.md18
2 files changed, 18 insertions, 19 deletions
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)
+