colonel

Go to file

Nicolás Ortega Froysa 8b4f67dc3e Created toolchain file.		2018-03-14 18:31:58 +01:00
configs	Change of name.	2018-03-11 17:47:43 +01:00
src/kernel	Added GDT.	2018-03-14 17:10:51 +01:00
toolchains	Created toolchain file.	2018-03-14 18:31:58 +01:00
.gitignore	Initial commit.	2018-03-08 16:53:29 +01:00
LICENSE	Licensing	2018-03-08 16:56:23 +01:00
README	Edited description.	2018-03-14 18:18:51 +01:00

README

===============
*** Colonel ***
===============
Colonel (pronounced as it is spelt) is a small hobby kernel project
that I'm working on. It currently supports the following architectures:

 - x86

# Compiling
-----------
This project uses Clang (https://clang.llvm.org/) and NASM
(http://www.nasm.us/) for building. You will also require GNU Make
(https://www.gnu.org/software/make/), unless you want to manually go
through and compile the files.

To compile a full image you can run `make build-iso`, which will use
GNU GRUB (https://www.gnu.org/software/grub/) as the bootloader. Else,
just run `make` and it will build the kernel into a file called
`colonel.bin`. You can run the latter with QEMU (https://www.qemu.org/)
by using the `-kernel` option.

# License
---------
This project is licensed under the terms and conditions of the GNU
General Public License version 3 or greater (/LICENSE).