From d6d1bdfefafff50b7b6d15d218c0a188570be541 Mon Sep 17 00:00:00 2001
From: Andreas Baumann <mail@andreasbaumann.cc>
Date: Sat, 10 Jun 2017 21:26:24 +0200
Subject: some big renames into subdirs of aspects updated README removed
 size_t in sys/types.h and sys/types.h itself, size_t is in stddef.h

---
 src/README | 34 +++++++++++++++++++++++++++++-----
 1 file changed, 29 insertions(+), 5 deletions(-)

(limited to 'src/README')

diff --git a/src/README b/src/README
index 0d1719c..c1f1577 100644
--- a/src/README
+++ b/src/README
@@ -1,3 +1,8 @@
+boot
+----
+
+Simple bootloader, loading in two phases and loading the kernel itself
+
 * boot.bin - boot sector (stage 1 and 2, total 2k), offset 0x7c00
   * boot.asm - the main boot sector code using:
 * kernel.bin - linked kernel with fix start offset 0x8400
@@ -9,20 +14,39 @@
 * magic.bin (512 bytes magic marker sector)
   * magic.asm
 
-kernel utility routines
+kernel
+------
+
+Kernel main and utility routines like early consoles.
+
 * kernel.c - kernel helper functions
-* port.c, port.asm - I/O ports
-* interrupts.c, interrups.asm - interrupt handlers
-* pci.c - PCI introspection and driver initialization
 * console.c - the kernel console, can use VGA or serial port for now
 * vga.c - VGA basic output routines for early kernel output
 * serial.c - serial output to COM1 (only sequential ASCII chars, no terminal)
 
-kernel drivers
+hardware
+--------
+
+Hardware abstraction layer.
+
+* port.c, port.asm - I/O ports
+* interrupts.c, interrups.asm - interrupt handlers
+* pci.c - PCI introspection and driver initialization
+
+drivers
+-------
+
+Driver framework and specific drivers.
+
 * driver.c - generic driver manager
 * keyboard.c - PS/2 keyboard
 * mouse.c - PS/2 mouse
 
+libc
+----
+
+Stub C library implementation.
+
 C library definitions
 * stddef.h - definition of NULL, size_t
 * limits.h - domain range constants like INT_MAX
-- 
cgit v1.2.3-54-g00ecf