From 401083d1b6bec76e2eb69bcca819fcbc0b98c6ea Mon Sep 17 00:00:00 2001
From: Hqnnqh <hannah@diefluchs.at>
Date: Sun, 12 Jan 2025 21:01:07 +0100
Subject: [PATCH] docs: update readme

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index 6e06e68..ab1d03a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,37 @@
 # nebula os
+
+A x86-64 hobby operating system written entirely from scratch in Rust.
+
+## Getting Started
+
+### Prerequisites
+- A computer or virtual machine with UEFI support.
+- A Rust toolchain installed via [rustup](https://rustup.rs/).
+- QEMU (for testing)
+
+### Cloning the Repository
+
+Clone the repository to your local machine:
+
+```bash
+git clone https://github.com/nebulafoundation/nebula-os.git
+cd nebula-os
+```
+
+### Running
+
+#### QEMU
+
+```bash
+make run release=true
+```
+
+#### Real Machine
+
+```bash
+make usb USB_DEVICE=/dev/<device> release=true
+```
+
+> Makefile will later be replaced by proper boot utility
+
+