aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fe6d268
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# flappy-gb
+
+A simple flappy bird clone for the Gameboy, written in C using the [GBDK](https://github.com/gbdk-2020/gbdk-2020).
+To compile, run `build.sh`. Alternatively, a build is available in the releases section.
+Thanks to GamingMonsters for their [tutorials](https://www.youtube.com/playlist?list=PLeEj4c2zF7PaFv5MPYhNAkBGrkx4iPGJo), the excellent [GBDK documentation](https://bbbbbr.github.io/gbdk-2020/docs/api/index.html), and the [Pandocs](https://gbdev.io/pandocs/).