From d91024fb750356bad65cce5bdef206e530b37c53 Mon Sep 17 00:00:00 2001
From: Marvin Borner
Date: Sat, 21 Sep 2019 12:33:23 +0200
Subject: Added build instructions

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..820746a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Melvix
+<p align="center">
+    <i>„A lightweight unix-like operating system“</i>
+</p>
+
+## Build
+* Use any system running GNU/Linux (Successfully tried building on Debian, Arch Linux and even OpenBSD)
+* Install build dependencies (package names may vary depending on your operating system)
+    * binutils
+    * gcc
+    * make
+    * bison
+    * flex
+    * gmp
+    * mpc
+    * mpfr
+    * texinfo
+    * curl
+    * nasm
+    * grub
+    * qemu
+* Run `make` 
+* Test Melvix in QEMU (should open automatically after successful `make`)
+* Optional: Flash the built ISO to a USB/Floppy/CD drive using `sudo dd if=./build/melvix.iso of=/dev/sdX bs=4M oflag=sync`
-- 
cgit v1.2.3