Added README HEAD master

1 files changed, 23 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..b86cba4
--- /dev/null
+++ b/README
@@ -0,0 +1,23 @@
+Hello world for Nintendo Game Boy
+
+=== About ===
+This is the source code for a simple "Hello World" for the Nintendo Game Boy 
+(1989). This is here as a refrence to see how asm works for the Game Boy.
+
+=== Compile ===
+In order to compile, you will need RGBDS[0] installed. Then run the following 
+commands:
+
+
+rgbasm -o main.o main.asm
+
+rgblink -o hello-world.gb main.o
+
+rgbfix -v -p 0 hello-world.gb
+
+
+You should now have a Game Boy ROM that will run in any emulator or even the 
+real hardware is using a flashcart!
+
+=== Links ===
+[0]: https://rgbds.gbdev.io/
\ No newline at end of file