update readme
This commit is contained in:
parent
6547b45cc7
commit
c6b5f391a9
2 changed files with 19 additions and 17 deletions
30
README.md
30
README.md
|
@ -1,10 +1,22 @@
|
|||
# Comus
|
||||
# Finix
|
||||
|
||||
Comus is a kernel!
|
||||
Finix is a kernel!
|
||||
|
||||
## Contributors
|
||||
|
||||
1. Freya Murphy <freya@freyacat.org>
|
||||
2. Tristan Miller <trimill@trimill.xyz>
|
||||
3. Simon Kadesh <simon@kade.sh>
|
||||
4. Ian McFarlane <i.mcfarlane2002@gmail.com>
|
||||
5. Galen Sagarin <gsp5307@rit.edu>
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the [GNU General Public License, version 2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).
|
||||
|
||||
## Dependencies
|
||||
|
||||
To build comus, a c11 compiler is required, along with the gnu assembler
|
||||
To build finix, 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.
|
||||
|
@ -29,16 +41,12 @@ Run `make fmt` to format the source code.
|
|||
|
||||
For development on NixOS run `nix develop` in the source directory.
|
||||
|
||||
## Docs
|
||||
|
||||
See `docs/`
|
||||
|
||||
## UEFI
|
||||
|
||||
Add `UEFI=1` as an argument to the makefile to build and run in UEFI.
|
||||
|
||||
Requires the nix flake.
|
||||
|
||||
## Docs
|
||||
|
||||
See `docs/`
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the GPLv2
|
||||
|
|
|
@ -2,12 +2,6 @@ Comus is a 64-bit paging kernel.
|
|||
|
||||
Created for CSCI.452.01
|
||||
|
||||
## Members
|
||||
|
||||
- Freya Murphy
|
||||
- Ian McFarlane
|
||||
- Galen Sagarin
|
||||
|
||||
## Source Code
|
||||
|
||||
https://github.com/kenshineto/kern
|
||||
|
|
Loading…
Add table
Reference in a new issue