colonel/README

26 lines
899 B
Plaintext
Raw Normal View History

2018-03-12 16:57:30 +00:00
===============
*** Colonel ***
===============
2018-03-14 17:18:51 +00:00
Colonel (pronounced as it is spelt) is a small hobby kernel project
that I'm working on. It currently supports the following architectures:
2018-03-12 16:57:30 +00:00
- 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.
2018-03-12 16:57:30 +00:00
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).