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

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

(limited to 'kernel')

diff --git a/kernel/README.md b/kernel/README.md
new file mode 100644
index 0000000..0b25f39
--- /dev/null
+++ b/kernel/README.md
@@ -0,0 +1,7 @@
+# Kernel
+
+The kernel is the interface between the computer hardware and the userspace. It handles everything from file and process management to resource allocation, computer interfaces like keyboards/mice and networking features. This interface is mainly established using syscalls (`features/syscall.c`).
+
+While the main goal of Melvix is definitely not the security aspect, the kernel should be fairly secure. It implements memory protecting features like paging and address validation, SMEP/SMAP, ASLR, ring 3 processes, protected memory sharing, process based syscall validation (abstraction to default, super and kernel processes) and much more.
+
+The directory structure consists of `drivers/`, the home of all hardware-interacting device drivers, and `features/`, the home of interfaces that are not directly tied to the hardware but rather to other features of the kernel or userspace. The `inc/` directory is the location of all kernel header files.
-- 
cgit v1.2.3