HighlightOS

x86_64 OS (kernel) made completely from scratch in Assembly & Rust

Table of contents

• Build from source on Linux
• Run in QEMU on Linux
• Run on real hardware
• Appendix
  • Development status
  • Additional info
  • Credits

Build from source on Linux

Main Kernel

Requirements:

• Git version control system
• Rust toolchain

Steps:

1. Install the nightly toolchain:

   rustup toolchain install nightly

2. Install required components:

   rustup component add rust-src --toolchain nightly-x86_64-unknown-linux-gnu && rustup component add llvm-tools-preview --toolchain nightly-x86_64-unknown-linux-gnu && cargo install bootimage

3. Create a local clone of the repository:

   git clone git@github.com:adamperkowski/highlightos.git && cd highlightos

4. cd into the kernel/ directory:

   cd kernel

5. Build the bootable binary:

   cargo bootimage --release

   This command will create the target/target/release directory in which you'll find the bootimage-hlkernel.bin binary file.

HighlightOS ASM

Requirements:

• Git version control system
• NASM Assembly compiler

Steps:

1. Create a local clone of the repository:

   git clone git@github.com:adamperkowski/highlightos.git && cd highlightos

2. cd into the asm/ directory:

   cd asm

3. Compile the bootable binary:

   nasm -f bin boot.asm -o boot.bin

   This command will generate & place the boot.bin file inside of the current directory.

Run in QEMU on Linux

Requirements:

• QEMU (full package)
• A bootable binary of HighlightOS. You can download one from releases or you can build it yourself.

Steps:

1. cd into directory that contains the binary.
2. Run the following command:

   qemu-system-x86_64 -drive format=raw,file=<your_binary_filename>.bin

   [!IMPORTANT] Replace <your_binary_filename> with the actual name of the binary you have downloaded/built.

Run on real hardware

You can also flash the binary image onto a USB stick and boot it on a real machine.

You can flash it by running the following command:

dd if=<your_binary_filename>.bin of=/dev/sdX && sync

[!IMPORTANT] Make sure to replace <your_binary_filename>.bin with your downloaded/compiled binary name and make sure to replace /dev/sdX with your USB's actual partition number. Any data on it will be lost!

[!NOTE] You can choose the device to boot off of from your BIOS boot menu (accessible by pressing F8 or F12).

Double-check that your motherboard is capable of booting legacy media(s), as HighlightOS is not UEFI-compatible yet.

Appendix

Development status

https://github.com/user-attachments/assets/663e8477-4275-411b-a39a-c12e54096ad8

Additional info

Did you know we have a IRC channel? It's #highlightos on libera.chat.

List of built-in commands and features is available here.
To gain further information on HighlightOS, we invite you to visit the wiki.

Using precompiled binaries from the code section of the repo is not recommended.

Contributors

HUGE thanks to everyone contributing:

Credits

Some parts of the code are inspired by blog_os. Great project!

Copyright

Copyright © 2024 Adam Perkowski

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.