pearlOS: Operating system

pearlOS is an awesome operating system based of the pidi-os project that was sadly discontinued, but I highly recommend you to check out the new rust-based operating system made by the same author; RezOS. But ofcourse only do that after you check out this project! pearlOS was made for me to learn operating system things and also to become better at C and Assembly.

Requirements

• Make
• NASM
• Clang
• QEMU

Installation

Note

Compilation is only guaranteed on linux with Clang ISO C17, but it is also possible in Windows with virtualization solutions like WSL (on Windows 11) or hyperV.

PearlOS prides itself in it's incredibly easy installation, as it only requires 3 commands! It's very easy to install, firstly clone the repo:

git clone https://github.com/ElisStaaf/pearlOS

After going into the repo directory, configure and then make:

./configure
make qemu

## NOTE: To build with GCC, instead of running
##       "make qemu", run:
scripts/gcc.sh qemu

This will start up a QEMU session with the image, and you can run the OS.

NOTE: To add your own config (and then run it using ./configure), you can read the docs.

Uninstalling

To uninstall, simply run:

make clean

Differences

If you want to see the differences between pearlOS and pidi-os, see PIDI-DIFF.md.

Contributing

I accept all meaningful contributions! As long as it doesn't break the project, I'll probably accept your contribution.

Activity

I'm a bit inconsistent on when I actually, y'know, maintain and update this, but I can assure you, even if you see a 1-month pause, THE PROJECT IS NOT DEAD. If the project dies, you can expect archival or at least a message.

Documentation

The official pearlOS documentation can be viewed here, but keep in mind that I'm not that consistent on updating the documentation, though it becomes pretty clear on what you have to do if you just... rtfc (read the fucking code).

License

Unless explicitly stated, every single modified file in this project is licensed under the Apache 2.0 License, while the unmodified files are licensed under MIT. The "SPDX-License-Identifier" rule obviously overrides this option, and is how you explicitly state a different license. See LICENSE for the 2 main licenses.