Commented about the directory structure.

This commit is contained in:
Nicolás Ortega Froysa 2018-02-24 10:03:20 +01:00
parent 37cb11cec0
commit a9a0aa79ed
No known key found for this signature in database
GPG Key ID: FEC70E3BAE2E69BF

View File

@ -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`. 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 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). 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).