From 6944f2203f285425c49d29ae3e368f6294ee040b Mon Sep 17 00:00:00 2001
From: Julien CLEMENT <julien.clement@epita.fr>
Date: Sun, 5 Dec 2021 21:25:13 +0100
Subject: [PATCH] feat(readme): update readme with build requirements

Signed-off-by: Julien CLEMENT <julien.clement@epita.fr>
---
 Makefile  |  1 +
 README.md | 16 ++++++++++++++++
 2 files changed, 17 insertions(+)

diff --git a/Makefile b/Makefile
index 345464a..0252a4e 100644
--- a/Makefile
+++ b/Makefile
@@ -41,5 +41,6 @@ clean:
 	$(RM) $(KERNEL)
 	$(RM) julios.iso
 	$(RM) -r iso
+	$(RM) -r target
 
 .PHONY: $(INSTALL_ROOT) install clean all run debug $(LIB_JULIOS)
diff --git a/README.md b/README.md
index e0f9906..3112118 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
 # JuliOS
 
 Just an Unstable, Lame and Innefective Operating System
+
+# Build requirements
+
+* rust nightly
+* rust-src (`rustup component add rust-src`)
+* grub2
+* xorriso
+
+# Build
+
+```sh
+make        # The kernel and an ISO
+make run    # Run qemu on the ISO
+make debug  # Run bochs on the ISO
+make clean  # Clean everythin
+```