OBOS

OBOS uses ✨ state of the art technology ✨ to do ✨ almost nothing ✨

Building

Prerequisites

• (For an x86-64 build) NASM
• (For an x86-64 build): x86_64-elf gcc or an x86_64-obos toolchain (if you use method one, this is done for you)
• CMake
• xorriso
• Ninja
• Git (unoptional, even if the repo was downloaded manually)
• (Optionally): Qemu to run the iso
• (if using method one) libcjson

Build

Method 1

1. Clone the obos-pkgs repo using git:

git clone https://github.com/OBOS-dev/obos-pkgs.git

2. Enter the newly clone repo
3. Run the following commands to build an OBOS distribution:

cp settings-x86_64.json settings.json
./obos-strap setup-env
./obos-strap install bootstrap-binutils
export PATH=$PATH:$PWD/host_pkgs/bin
./obos-strap install all

4. Use qemu or any other emulator to run your ISO.

Method 2 (for kernel contributors)

1. Clone the repo using git:

git clone https://github.com/OBOS-dev/obos.git

2. Enter the newly cloned repo
3. Run cmake to build the OS (x86_64)

touch config/initrd.tar
cmake -GNinja -DCMAKE_BUILD_TYPE=Debug --toolchain=src/build/x86_64/toolchain.cmake -B build/x86_64 .
chmod +x dependencies/hyper/hyper_install-linux-x86_64
cmake --build build/x86_64
scripts/generate_initrd-x86_64.sh
cmake --build build/x86_64

4. To run the kernel, run the script under scripts/launch_qemu.[bat,sh]

(Linux)

cd scripts
chmod +x ./launch_qemu.sh
./launch_qemu.sh

(Windows)

cd scripts
call launch_qemu.bat

Credits

• My friend @LemurLord16 (@sigsbeedrive on discord) for listening to me yap about new features.
• My cousin Ali because why not.

License Notice

Most code in this repository is licensed under the MIT license.
Any code from other projects that require a license notice will be put below.

src/oboskrnl/utils/tree.h

Taken from sys/tree.h from OpenBSD, and is licensed under this:

 Copyright 2002 Niels Provos <provos@citi.umich.edu>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.