unsafecast / MandelbrotOS

A community driven OS by the youth

Welcome

Welcome to the Mandelbrot Operating System. This OS is built by a humble group of teenagers over at Discord. We do this solely to have fun and to learn. We are not organized and are here to enjoy ourselves. Sounds appealing? Create a pull request!

About

This project is made for fun and learning. It's like tracing OS history, but with modern knowledge and without a lot of budget lol

Where are we in the project

• A filesystem is being developed. ATA is somewhat functional but still needs testing.
• We have our own fork of limine which can boot from the flatfs.

Build Requirements

Arch/Manjaro

• sudo pacman -S base-devel qemu nasm xorriso mtools wget'

Debian/Ubuntu

• sudo apt-get install build-essential qemu nasm xorriso wget

Running

You'll need to have a cross-compiler and all the tools, build them using cd scripts && ./build-tools.sh. Run make to compile the OS and run it in qemu (needs qemu-system-x86_64) or just RUN=1 make to compile it

Using

By default the OS does nothing as we don't have a userland but stuff can be added to the kernel for testing purposes. There will often be remaining test code that is left over.

Commiting

We code using GCC so any clang standards that may affect GCC will be ignored.
We also format our code in clang format so make sure to clang format the code before commiting.
We code in gnu99 standards. So this is C99 with GNU extensions. It is automatically set in the makefile. Just beware of that when coding.
When returning an error code from a function: make sure that returning 0 is success code. All other return codes are errors/failures and can be used to show what went wrong Name variables in snake case (uint64_t name_of_var)
Give types _t's (typedef long int name_of_type_t). Make sure this is in snake case too!
Constants must be in screaming snake case (All capitals snake case) (#define SOME_CONSTANT 0x1000)
Macros follow the same laws as constants. (#define MAX(a, b) ({int \_a = (a), \_b = (b); \_a > \_b ? \_a : \_b; }))
All comments are allowed but I would prefer if you used // instead of /\*\*/
All header files must have an ifndef with the file name in screaming snake case with double underscores on each side of them like this:

#ifndef __SOME_FILE_NAME_H__
#define __SOME_FILE_NAME_H__

// Code

#endif

Using code

This is an open source project. Reuse code. Just follow the license terms and we are good. :)