aboutsummaryrefslogtreecommitdiffstats
path: root/README.pret.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.pret.md')
-rw-r--r--README.pret.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.pret.md b/README.pret.md
new file mode 100644
index 00000000..dcc01df6
--- /dev/null
+++ b/README.pret.md
@@ -0,0 +1,29 @@
+# Pokémon Yellow [![Build Status][ci-badge]][ci]
+
+This is a disassembly of Pokémon Yellow.
+
+It builds the following ROMs:
+
+- Pokemon Yellow (UE) [C][!].gbc `sha1: cc7d03262ebfaf2f06772c1a480c7d9d5f4a38e1`
+- YELLMONS.GB (debug build) `sha1: d44e96eddfbdad633cbe4e6e64915e9e198974b0`
+- Dmgapse0.h08.patch `sha1: f3346a5559d52c296b8feab0cdbbfb0e250ac161`
+
+To set up the repository, see [**INSTALL.md**](INSTALL.md).
+
+
+## See also
+
+- [**Wiki**][wiki] (includes [tutorials][tutorials])
+- [**Symbols**][symbols]
+- [**Tools**][tools]
+
+You can find us on [Discord (pret, #pokered)](https://discord.gg/d5dubZ3).
+
+For other pret projects, see [pret.github.io](https://pret.github.io/).
+
+[wiki]: https://github.com/pret/pokeyellow/wiki
+[tutorials]: https://github.com/pret/pokeyellow/wiki/Tutorials
+[symbols]: https://github.com/pret/pokeyellow/tree/symbols
+[tools]: https://github.com/pret/gb-asm-tools
+[ci]: https://github.com/pret/pokeyellow/actions
+[ci-badge]: https://github.com/pret/pokeyellow/actions/workflows/main.yml/badge.svg