summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRangi <remy.oukaour+rangi@gmail.com>2020-08-08 17:02:30 -0400
committerRangi <remy.oukaour+rangi@gmail.com>2020-08-08 17:02:30 -0400
commit0a82eb6523b0c839d3eedcdce0aeaeae5289e726 (patch)
treedbea835c905fbc0d1e26b3c1c92bd55f7d161136 /README.md
parent0033759a90281f927f7adfd06b64b84af6d8ca83 (diff)
Set up Travis CI
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 38 insertions, 9 deletions
diff --git a/README.md b/README.md
index 858ce5c..fa02851 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,44 @@
-WIP disassembly of the Space World 1997 Gold proto
+# Pokémon Gold and Silver: Space World 1997 Demo [![Build Status][travis-badge]][travis]
-It attempts to build the following ROMs:
+This is a work-in-progress disassembly of the Pokémon Gold and Pokémon Silver prototypes demoed at Space World 1997.
-pokegold_spaceworld.gb (MD5: 3c407114de28d17b7113a2c0cee9a37c)
-pokegold_debug_spaceworld.gb (MD5: 2eadbed83b775c097ff79e5128d1184f)
-pokesilver_spaceworld.gb (MD5: c52a677c35f15320d5b495e14809f00d)
-pokesilver_debug_spaceworld.gb (MD5: fa65d3759bb17c489de171a598ba4913)
+It builds the following ROMs:
+
+- Gold_debug.sgb `md5: 2eadbed83b775c097ff79e5128d1184f`
+- Gold_debug.sgb (correct header) `md5: 8e509301f6db1f89fee85aead8ebf8d4`
+
+You will need to provide a copy of Gold_debug.sgb renamed **baserom.gb** to build the ROMs.
+
+You will also need **rgbds 0.3.8**. If that is not your default version, you can put the 0.3.8 files in a subdirectory like rgbds/ and run `make RGBDS=rgbds/` instead of `make`.
-Requires [RGBDS](https://github.com/rednex/rgbds) version 0.3.8 or newer to build!
## See also
-* Discord: [**pret**][Discord]
-[Discord]: https://discord.gg/d5dubZ3
+- **Discord:** [pret][discord]
+- **IRC:** [freenode#pret][irc]
+
+Other disassembly projects:
+
+- [**Pokémon Red/Blue**][pokered]
+- [**Pokémon Yellow**][pokeyellow]
+- [**Pokémon Gold**][pokegold]
+- [**Pokémon Crystal**][pokecrystal]
+- [**Pokémon Pinball**][pokepinball]
+- [**Pokémon TCG**][poketcg]
+- [**Pokémon Ruby**][pokeruby]
+- [**Pokémon FireRed**][pokefirered]
+- [**Pokémon Emerald**][pokeemerald]
+
+[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
+[pokeruby]: https://github.com/pret/pokeruby
+[pokefirered]: https://github.com/pret/pokefirered
+[pokeemerald]: https://github.com/pret/pokeemerald
+[discord]: https://discord.gg/d5dubZ3
+[irc]: https://kiwiirc.com/client/irc.freenode.net/?#pret
+[travis]: https://travis-ci.org/pret/pokegold-spaceworld
+[travis-badge]: https://travis-ci.org/pret/pokegold-spaceworld.svg?branch=master