From a9a0aa79ed949905906ec2f7c8727c7e89e80ced Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Ortega=20Froysa?= Date: Sat, 24 Feb 2018 10:03:20 +0100 Subject: [PATCH] Commented about the directory structure. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 4611c02..83a606a 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,13 @@ Compiling --------- I cross-compile from `x86_64` to `x86` (64 to 32-bit) on my machine, but all the code is plain `x86`. You will require `gcc` and `nasm` (as well as the normal GNU core utils) and you can run the final image using [QEMU](https://www.qemu.org/). To compile just run `make`. +Code Structure +-------------- + - `boot/`: code necessary for the boot process (i.e. loading the kernel and switching to 32-bit protected mode). + - `kernel/`: code related to the kernel itself. + - `drivers/`: interface code that simplifies interaction with hardware devices. + - `bin/`: binary directory where final `os-image` is stored. + License ------- Since this code is made with the help of the above mentioned book so generously created (yet incomplete), I've licensed this repo under the [Unlicense](/LICENSE).