Go to file
Nicolás Ortega Froysa 2ca0402fba
Added a README
2018-03-12 17:57:30 +01:00
configs Change of name. 2018-03-11 17:47:43 +01:00
src/kernel Getting ready to add a TSS. 2018-03-09 18:19:52 +01:00
.gitignore Initial commit. 2018-03-08 16:53:29 +01:00
LICENSE Licensing 2018-03-08 16:56:23 +01:00
Makefile Change of name. 2018-03-11 17:47:43 +01:00
README Added a README 2018-03-12 17:57:30 +01:00

===============
*** Colonel ***
===============
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).

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