Home

Awesome

Proxima

A monolithic Unix-like operating system

Build instructions

Make sure all submodules are up-to-date before beginning.

Simple build

If you just want an ISO image, run the build.sh script. It takes the target architecture as an argument, and creates an ISO image for you (at build/proxima.iso):

./build.sh x86_64

Advanced build

Proxima is built just like any other CMake project. It is recommended to use the provided Clang-based toolchain files, since that is what is used to develop the project. Currently, only x86_64 is supported: cmake -S . -B build --toolchain cmake/cross/x86_64.cmake

Note that some parts of Proxima rely on LTO inlining for cleaner code. If you are making a release build, it is recommended to enable LTO.

If you are installing Proxima to a hard drive, flash drive, or similar, just install it as any other CMake project (with an appropriate --prefix, of course). This does not install a bootloader, you must set it up on your own.

If you want an ISO image, use the mkiso.sh script:

../scripts/mkiso.sh proxima.iso

Note that this script must be ran from within the CMake build directory. This downloads and sets up the bootloader for you. The script does not build Proxima; you must do that yourself first, or the ISO will only contain the bootloader and nothing else.