https://github.com/cr0a3/nem

https://github.com/cr0a3/nem

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/cr0a3/nem
• Owner: Cr0a3
• License: 0bsd
• Created: 2024-04-03T15:51:59.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-06-11T15:20:18.000Z (7 months ago)
• Last Synced: 2024-10-19T08:15:31.890Z (3 months ago)
• Language: Rust
• Size: 13.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Limine Rust Template

This repository will demonstrate how to set up a basic x86-64 kernel in Rust using Limine.

## 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`.

### 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.