forked from Hyperion/HyperionOS
fixed ghxx exploit
This commit is contained in:
50
README.md
50
README.md
@@ -1,25 +1,51 @@
|
||||
# HyperionOS
|
||||
|
||||
**HyperionOS** is a modular operating system environment written entirely in Lua. It features a microkernel-inspired architecture with a robust system call (syscall) interface, and a virtual file system (VFS).
|
||||
|
||||
## Key Features
|
||||
* **Modular Kernel:** Functionality is distributed across discrete kernel modules (`.kmod`), including IO, VFS, IPC, and TTY, allowing for a highly extensible system.
|
||||
|
||||
* **Hypervisor & Task Management:** A custom hypervisor manages threads in a task-based architecture.
|
||||
HyperionOS is a modular, hybrid kernel operating system written entirely in Lua. It features a custom task scheduler, virtual filesystem, syscall interface, and separates core functionality from user-space services.
|
||||
|
||||
---
|
||||
|
||||
## Build requirements
|
||||
* **Source:** None it builds directly in vs-code, altough it is the biggest build method it gives the most readability
|
||||
## Features
|
||||
|
||||
* **Minifyed:** You need node.js and luamin
|
||||
- Functionality is split into kernel modules (`.kmod`)
|
||||
- Task-based lightweight thread/task scheduler with process isolation and IPC support
|
||||
- Virtual filesystem unified interface for disk, RAM, and virtual filesystems
|
||||
- TTY & Shell
|
||||
|
||||
---
|
||||
|
||||
## Kernel Modules
|
||||
|
||||
Modules are loaded in priority order from `/lib/modules/`.
|
||||
|
||||
You can add your own `.kmod` files to extend kernel functionality without modifying the core.
|
||||
|
||||
---
|
||||
|
||||
## Debugging & Logging
|
||||
|
||||
The kernel logs to `/var/log/syslog.log` during runtime.
|
||||
You can also view real-time loading logs during boot if `showModLoad` in boot.cfg is enabled.
|
||||
|
||||
To trigger a panic (for testing):
|
||||
```lua
|
||||
kernel.PANIC("Test panic message")
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
* **Credit:** if you contributed feel free to add your name to contributors.md
|
||||
|
||||
Contributions are welcome, though please follow these guidelines:
|
||||
|
||||
1. No AI-generated kernel code, keep the core human written.
|
||||
2. Modularize, new features should go into kernel modules where possible.
|
||||
3. Document, update comments and docs when adding/changing functionality.
|
||||
4. Test, ensure your changes don’t break existing functionality.
|
||||
|
||||
Add your name to `contributors.md` when your PR is merged.
|
||||
|
||||
---
|
||||
|
||||
## Rules/guidelines
|
||||
* **AI:** AI **stays out of the kernel** you may use AI to create tests and for debugging. if it is not important you may use AI.
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License. See the LICENSE file for details.
|
||||
|
||||
Reference in New Issue
Block a user