XCore Kernel
============

This software is licensed under the 3-clause BSD ("New" or "Revised") license.
Please see LICENSE for more info.

------------ General info

XCore is a microkernel that aims to be easy to maintain and have decent performance.
Other goals are not yet known, but will in the future.

XCore has a bug tracker(1), a mailing list(2), and, well, the main source repository(3).
You can go there if you want to. We also have a MAINTAINERS file if you want to get our
contact information. NOTE: The mailing list appears to not work with Tuta mail.

------------ Building

XCore is made using only Zig(4), therefore the only thing you need is zig 0.14.0.
Follow the instructions(5) for how to install zig 0.14.0. The `run` step runs the kernel 
binary inside the QEMU emulator for the specified target (e.g -Dtarget=x86-freestanding).

NOTE: XCore DOES NOT provide an ISO image. You must build it yourself either using GNU GRUB
or any other bootloader of choice that supports multiboot-compliant binaries. XCore itself
is a multiboot-compliant binary, so should run with pretty much any bootloader supporting it.

------------ Source code roadmap
 __________________________________________
| PATH    | DESCRIPTION                    |
|---------|--------------------------------|
| src/    | The root source tree of XCore. |
|         | Contains all the architecture- |
|         | agnostic code.                 |
|---------|--------------------------------|
| src/x86 | The x86 platform source.       |
|---------|--------------------------------|
| driver  | The built-in platform drivers. |
|---------|--------------------------------|
| cpu     | CPU-related functionality.     |
|---------|--------------------------------|

============ Links

(1) https://todo.git.m0e.space/~littleendian/xcore-todo
(2) https://lists.git.m0e.space/~littleendian/xcore-dev
(3) https://git.m0e.space/~littleendian/xcore
(4) https://ziglang.org
(5) https://ziglang.org/learn/getting-started/

Copyright (c) 2025 Andrij Glyko. All Rights Reserved.