From 2a2d68987890656385c4737d5f8037d61f1e2a00 Mon Sep 17 00:00:00 2001
From: Carlos Bandeira <porem5002@gmail.com>
Date: Wed, 30 Aug 2023 00:23:20 +0100
Subject: [PATCH] Added README

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..be0c0db
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# Flappy Odin
+A flappy bird clone developed using the [Odin Programming Language](https://odin-lang.org/) and [Raylib](https://www.raylib.com/).
+
+## Install 
+To install the game checkout the Releases section and select the binaries that are compatible with your platform.
+
+If your current platform is not available for your platform, consider taking building the project for your platform, see how to do it [here](#build).
+
+## Play
+
+To play the game run the **executable** called **flappy_odin**.
+
+Controls:
+- **ESC** - Exit
+- **ENTER** - Proceed/Unpause 
+- **SPACE** - Jump
+- **F** - Toggle Fullscreen
+
+## Build
+
+If you want to build the project in your own machine you will need to have the [Odin Programming Language](https://odin-lang.org/) installed in your PC and make it accessible via your **PATH** environment variable.
+
+After doing this, run the following commands according to your platform and your needs.
+
+### On Windows
+Generate Release Build:
+```
+.\build.bat release
+```
+Generate Debug Build:
+```
+.\build.bat
+```
+
+### On Linux
+Generate Release Build:
+```
+make release
+```
+Generate Debug Build:
+```
+make
+```
+
+## License
+[MIT License](./License)
\ No newline at end of file