banan-os/README.md

banan-os

This is my hobby operating system written in C++. Currently supports only x86_64 architecture. We have a read-only ext2 filesystem, read-write ramfs, IDE disk drivers in ATA PIO mode, userspace processes, executable loading from ELF format, linear VBE graphics and multithreaded processing on single core.

Code structure

Each major component and library has its own subdirectory (kernel, userspace, libc, ...). Each directory contains directory include, which has all of the header files of the component. Every header is included by its absolute path.

Building

There does not exist a complete list of needed packages for building. From the top of my head I can say that cmake, ninja, make, grub, rsync and emulator (qemu or bochs) are needed.

Create the build directory and cofigure cmake

mkdir build
cd build
cmake -G Ninja ..

To build the toolchain for this os. You can run the following command.

NOTE: The following step has to be done only once. This might take a long time since we are compiling binutils and gcc.

ninja toolchain
cmake -G Ninja --fresh .. # We need to reconfigure cmake to use the new compiler
ninja libstdc++

To build the os itself you can run either of the following commands. You will need root access since the sysroot has "proper" permissions.

ninja qemu
ninja bochs

You can also build the kernel or disk image without running it:

ninja kernel
ninja image

If you have corrupted your disk image or want to create new one, you can either manually delete banan-os.img and cmake will automatically create you a new one or you can run the following command.

ninja image-full

NOTE ninja clean has to be ran with root permissions, since it deletes the root filesystem.

Contributing

Currently I don't accept contributions to this repository unless explicitly told otherwise. This is a learning project for me and I want to do everything myself. Feel free to fork/clone this repo and tinker with it yourself.