Added README and LICENSE

This commit is contained in:
River 2025-02-09 20:59:44 -05:00
parent 5af0c919f4
commit 867d45fe5c
Signed by: shibedrill
GPG Key ID: 5FE0CB25945EFAA2
2 changed files with 46 additions and 0 deletions

18
LICENSE Normal file
View File

@ -0,0 +1,18 @@
# GNU Public License v3
Gila - a microkernel OS written in Rust, and inspired by Xinu.
Copyright (C) 2025 shibedrill
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# Gila v0.1.0 - a Rust Microkernel
Gila is a Rust microkernel OS, inspired by the Xinu embedded OS. It will
hopefully be capable of multitasking some day. I do not intend for Gila to
be POSIX-like or compatible.
## Work In Progress
Gila does nothing at all right now. Check back later. Or contribute.
## Licensing
Licensed under the GNU Public License v3. See [LICENSE](LICENSE) for details.
## Navigating
- [boot.rs](src/boot.rs): Handles bootloader handoff. Gila uses Limine. Other bootloaders are NOT supported.
- [lib.rs](src/lib.rs): Glue to make all files accessible from [main.rs](src/main.rs).
- [main.rs](src/main.rs): The entry point that gets called by the bootloader.
- [memory.rs](src/memory.rs): Types relating to memory regions and allocation.
- [panic.rs](src/panic.rs): The panic handler and associated functionality.
- [process.rs](src/process.rs): Process types and functions.
- [resources.rs](src/resources.rs): Resources that are accessible from multiple parts of the code.
## Building and running - TODO
This section is under construction.