From 1f957aafa4423c1579627a279d861d03d76f3dbb Mon Sep 17 00:00:00 2001
From: Marvin Borner
Date: Mon, 5 Apr 2021 14:04:28 +0200
Subject: Added some documentation

---
 README.md | 35 ++++++-----------------------------
 1 file changed, 6 insertions(+), 29 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index f0c640c..1eb8106 100644
--- a/README.md
+++ b/README.md
@@ -37,35 +37,12 @@ This project is somewhat of a coding playground for me. It doesn't have any usef
 
 ## Documentation
 
--   [Memory map](MMAP.md)
-
-## Test
-
--   Install the qemu i386 emulator
--   Download the `disk-img` artifact from the newest stable [GitHub Workflow build](https://github.com/marvinborner/Melvix/actions?query=branch%3Amain)
--   Unzip `disk-img.zip`
--   Run `qemu-system-i386 -m 256M -vga std -drive file=path/to/disk.img,format=raw,index=1,media=disk -netdev user,id=net0 -device rtl8139,netdev=net0`
--   Try entering `browser`, `files`, `mandelbrot` (or any other program in `apps/`) into the input field and press enter
--   Move windows using `ALT`+`Left click`
--   Enjoy, or try building it yourself!
-
-## Build it yourself
-
--   Use any system running GNU/Linux or OpenBSD
-
--   Install build dependencies
-
-    -   General template: `[pkg_manager] [install] git binutils ccache gcc make bison flex gmp mpc mpfr texinfo curl nasm qemu inkscape` (package names may vary depending on your operating system)
-    -   Ubuntu/Debian: `apt-get install -y build-essential bison flex libgmp3-dev libmpc-dev libmpfr-dev texinfo ccache curl nasm grub-common qemu qemu-kvm mtools ctags inkscape`
-    -   OpenBSD: `pkg_add git ccache gcc g++ gmake bison gmp libmpc mpfr texinfo curl nasm qemu e2fsprogs inkscape`
-
--   Clone this repository using `git clone https://github.com/marvinborner/Melvix.git`
-
--   Switch to the stable `main` branch using `git checkout main`
-
--   Run `./run` (pure magic!)
-
--   If you need help: `./run to help`
+-   [Installation guide](docs/INSTALL.md)
+-   [Memory map](docs/MMAP.md)
+-   [Bootloader overview](boot/README.md)
+-   [Kernel overview](kernel/README.md)
+-   [Userspace overview](apps/README.md)
+-   [Library overview](libs/README.md)
 
 ## Contributions
 
-- 
cgit v1.2.3