colonel/README.md

15 lines
921 B
Markdown
Raw Normal View History

2018-03-11 16:47:43 +00:00
Colonel
=======
2018-03-08 16:05:58 +00:00
This is a small OS project I'm working on. It's slow progress and probably shouldn't be run anywhere except in an emulator. It currently supports the following architectures:
- x86
Compiling
---------
You'll want to setup a cross-compilation toolchain with [GCC](https://gcc.gnu.org/) for your target architecture, along with [GNU Make](https://www.gnu.org/software/make/) (I'll switch to the GNU autotools as soon as I can get them to work properly).
2018-03-11 16:47:43 +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.
2018-03-08 16:05:58 +00:00
License
-------
This project is licensed under the terms and conditions of the [GNU General Public License version 3 or greater](/LICENSE).