basickernel/README.md

BasicKernel
===========
This is code that I've been writing for a basic kernel from the [Writing a Simple Operating System from Scratch](https://web.archive.org/web/20241112015613/http://www.cs.bham.ac.uk/~exr/lectures/opsys/10_11/lectures/os-dev.pdf) book.

Compiling
---------
I cross-compile from `x86_64` to `i686` on my machine. You will require `i686-elf-gcc` and `nasm` (as well as all the rest of the GNU binutils for `i686`) 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).
Added a README.md 2018-02-23 17:24:34 +01:00			`BasicKernel`
			`===========`
Use Wayback Machine link. I've started getting a redirect on this website. It seems the link may be down, so I've changed it to the Wayback Machine to maintain consistency. 2025-02-25 13:22:24 +01:00			`This is code that I've been writing for a basic kernel from the [Writing a Simple Operating System from Scratch](https://web.archive.org/web/20241112015613/http://www.cs.bham.ac.uk/~exr/lectures/opsys/10_11/lectures/os-dev.pdf) book.`
Added a README.md 2018-02-23 17:24:34 +01:00
			`Compiling`
			`---------`
Updated the README.md 2018-02-28 22:56:58 +01:00			I cross-compile from `x86_64` to `i686` on my machine. You will require `i686-elf-gcc` and `nasm` (as well as all the rest of the GNU binutils for `i686`) and you can run the final image using [QEMU](https://www.qemu.org/). To compile just run `make`.
Added a README.md 2018-02-23 17:24:34 +01:00
Commented about the directory structure. 2018-02-24 10:03:20 +01:00			`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.

Added a README.md 2018-02-23 17:24:34 +01:00			`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).`