From: Lukas Krickl <lukas@krickl.dev>
Date: Tue, 19 Nov 2024 13:16:49 +0000 (+0100)
Subject: Updted readme.
X-Git-Url: https://git.krickl.dev/?a=commitdiff_plain;h=5a171074d8e453e8de1f3ce6b64cdd66c7396a99;p=gbrg%2F.git

Updted readme.

Added built instructions as well as a reference to ulas
---

diff --git a/README.md b/README.md
index 261b548..51c3df4 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# tbgb 
+# gbrg 
 
-An action rougelike platformer for the gameboy!
+An action rougelike for the gameboy
 
 ## Table of content
 
@@ -12,8 +12,13 @@ An action rougelike platformer for the gameboy!
 
 ## Installation
 
+To compile this game you will need a copy of `ulas`.
+Then simply run `make` to build the rom.
+
 ## Usage
 
+This game is compatible with any gameboy emulator.
+
 ### Building assets
 
 To build the assets simply check out the `assets repository` into the `assets` directory and run `make tiles`.
@@ -23,4 +28,4 @@ This is only required if changes to the tileset were made. All 'compiled' tile d
 
 This program is distributed under the terms of the MIT License.
 
-## Contributing
+