mirror of
https://github.com/XunilGroup/XunilOS.git
synced 2026-04-25 11:49:03 +02:00
35 lines
1.6 KiB
Markdown
35 lines
1.6 KiB
Markdown
# NeumannOS
|
|
NeumannOS is an OS written from scratch, named after the famous mathematician, physicist, computer scientist and engineer Neumann János Lajos.
|
|
|
|
The repo is based on the limine-rust-template.
|
|
|
|
## How to use this?
|
|
|
|
### Dependencies
|
|
|
|
Any `make` command depends on GNU make (`gmake`) and is expected to be run using it. This usually means using `make` on most GNU/Linux distros, or `gmake` on other non-GNU systems.
|
|
|
|
All `make all*` targets depend on Rust.
|
|
|
|
Additionally, building an ISO with `make all` requires `xorriso`, and building a HDD/USB image with `make all-hdd` requires `sgdisk` (usually from `gdisk` or `gptfdisk` packages) and `mtools`.
|
|
|
|
### Architectural targets
|
|
|
|
The `KARCH` make variable determines the target architecture to build the kernel and image for.
|
|
|
|
The default `KARCH` is `x86_64`. Other options include: `aarch64`, `riscv64`, and `loongarch64`.
|
|
|
|
Other architectures will need to be enabled in kernel/rust-toolchain.toml
|
|
|
|
### Makefile targets
|
|
|
|
Running `make all` will compile the kernel (from the `kernel/` directory) and then generate a bootable ISO image.
|
|
|
|
Running `make all-hdd` will compile the kernel and then generate a raw image suitable to be flashed onto a USB stick or hard drive/SSD.
|
|
|
|
Running `make run` will build the kernel and a bootable ISO (equivalent to make all) and then run it using `qemu` (if installed).
|
|
|
|
Running `make run-hdd` will build the kernel and a raw HDD image (equivalent to make all-hdd) and then run it using `qemu` (if installed).
|
|
|
|
The `run-uefi` and `run-hdd-uefi` targets are equivalent to their non `-uefi` counterparts except that they boot `qemu` using a UEFI-compatible firmware.
|