From 22129d78d5ddb00560c40ecb5dc2b63e3cabaa00 Mon Sep 17 00:00:00 2001
From: Inkbox <31674120+InkboxSoftware@users.noreply.github.com>
Date: Fri, 3 Oct 2025 19:36:13 +0800
Subject: [PATCH] Update README.md

Readme updated
---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2a0b8e3..92c00fc 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,36 @@
-"# spacegamex64" 
+# Space Game for x64
+Space Game for x64 is a recreation of Zaxxon for the x86_64 platform as a UEFI image. This project is released as open source under the GPLv3 license. 
+
+### Assemble
+Assemble via Microsoft Macro Assembler (set to 64-bit mode)
+```
+ml64.exe %TARGET%.s /c /Fo space.obj
+```
+### Link
+Link using Microsoft Visual C++ Linker
+```
+link.exe /nologo /SUBSYSTEM:EFI_APPLICATION /ENTRY:EFI_MAIN /MACHINE:X64 space.obj /OUT:BOOTX64.efi
+```
+
+### Running
+The compiled BOOTX64.EFI program must be placed in the EFI/BOOT/ directory of an EFI partition on a disk using a GPT. <br>
+The program can be run by entering the firmware settings, turning off secure boot, and selecting the disk as the device to boot from. 
+
+
+## Built in Options
+### Hardware upscaling
+When hardware upscaling is on, the program will use the application processors of the machine to quickly render the game buffer into the target 1024x1024 buffer. Otherwise if off, the program will simply output the 256x256 buffer to the screen. 
+```
+UPSCALE_MODE	DQ 00H	;0 FOR MULTI-CORE HARDWARE UPSCALED IMAGE OUTPUT, 1 FOR NO UPSCALING
+```
+### Hitboxes
+Show hitboxes. (Only useful when hardware upscaling is turned on)
+```
+SHOW_HITBOX		DQ 00H	;1 TO SHOW HIT BOXES
+```
+### Debug
+Show debug information on the console. Control input, column count. 
+```
+JMP DEBUGSKIP  ;Comment this line to show debug info on the console
+```
+