diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -2,6 +2,13 @@ Comus is a kernel! +## Dependencies + +To build comus, a c11 compiler is required, along with the gnu assembler +and linker. + +To build the boot iso for qemu, `grub-mkrescue` is needed from grub. + ## Build Run `make build` to build the kernel. @@ -16,6 +23,18 @@ Run `make qemu-gdb` to build and run in qemu with gdb debugging. Run `make gdb` to start the gdb debugger. +Run `make fmt` to format the source code. + +## Nix + +For development on NixOS run `nix develop` in the source directory. + +## UEFI + +Add `UEFI=1` as an argument to the makefile to build and run in UEFI. + +Requires the nix flake. + ## Docs See `docs/` |