Skip to content

nekernel-org/nekernel

Repository files navigation

NeKernel

CI CI License

NeKernel Logo

Getting Started

Requirements

Building & Running

Please fork, and clone the repository. Then follow those steps:

git clone https://github.com/<your-username>/nekernel.git
cd nekernel
./scripts/setup_x64_project.sh
./scripts/modules_ahci_x64.sh
./scripts/debug_ahci_x64.sh   # For debug generic AHCI target (QEMU)

Structure

  • src/kernel/ — Core kernel source (scheduling, memory, VFS, drivers)
  • src/boot/ — Bootloader, platform bring-up, and early system code
  • src/libDDK/ — Driver Development Kit (DDK) and sample drivers
  • src/libSystem/ — Userland system call interface and runtime
  • src/launch/ — NeKernel Launch System
  • src/libMsg/ — NeKernel OpenMSG framework
  • public/tools/ — CLI tools (mkfs, fsck, open, manual, etc.)
  • public/frameworks/ — Userland frameworks (CoreFoundation, DiskImage, etc.)
  • docs/ — Specifications, design docs, and diagrams

Security

  • Vulnerability Disclosure:
    Please report security issues privately via email or GitHub Security Advisories.

Documentation


Contributing

  • Please run format.sh before committing (uses .clang-format).
  • All contributions (code, docs, fuzzing, security) are welcome!

Authors & Credits


License

This project is licensed under the Apache-2.0 License.


© 2024-2025 Amlal El Mahrouss & NeKernel Authors. Licensed under the Apache 2.0 license.