# Melvix

<p align="center">
    <i>„A lightweight unix-unlike operating system“</i>
    <br><br>
    <a href="https://github.com/marvinborner/Melvix/actions?query=workflow%3A%22Lint,+build,+test,+release%22" target="_blank">
        <img src="https://img.shields.io/github/workflow/status/marvinborner/Melvix/lint,%20build,%20test,%20release?style=for-the-badge" />
    </a>
    <a href="https://app.codacy.com/gh/marvinborner/Melvix/dashboard" target="_blank">
        <img src="https://img.shields.io/codacy/grade/e68699c7f9314476a52acf9819a0a386/dev?style=for-the-badge" />
    </a>
    <a href="https://www.buymeacoffee.com/marvinborner" target="_blank">
        <img src="https://img.shields.io/static/v1?label=Support&message=buymeacoffee&color=brightgreen&style=for-the-badge" />
    </a>
</p>

## Disclaimer

This project is somewhat of a coding playground for me. It doesn't have any useful functionality (yet?). Be aware that the installation on real hardware is not recommended and may break your computer.

## Inactive

I've stopped developing Melvix because it wasn't interesting anymore. As I've rewritten Melvix many times, the following features may not all be available in the `dev` branch but scattered around all other branches and commits - sorry :P

## Features

-   From scratch (no POSIX/UNIX compatibility at all)
-   Multitasking
-   VFS with EXT2, DEVFS and PROCFS
-   Minimal GUI
-   Fast boot time (< 1s)
-   TCP/IP stack and rtl8139 driver
-   Small size (< 100KiB)
-   Sandboxed processes (paging, ring 3, SMAP/SMEP protections)
-   Full UBSan support
-   Compiles with `-Wall -Wextra -Werror -pedantic-errors -std=c99 -Ofast`

## Screenshot

![Melvix screenshot](screenshot.png?raw=true "Screenshot")

## Documentation

-   [Installation guide](docs/INSTALL.md)
-   [Memory map](docs/MMAP.md)
-   [Bootloader overview](boot/README.md)
-   [Kernel overview](kernel/README.md)
-   [Userspace overview](apps/README.md)
-   [Library overview](libs/README.md)

## Contributions

If you decide to contribute to this project, these are some ideas that could get you started:

-   Fix some `TODO`s in the code. While these are often not very well described, most of them should be self-explanatory
-   Fix issues posted on GitHubs issues tab
-   Improve the size/speed of the system or the overall performance of libraries and functions
-   Find/fix security issues and potentially write an exploit
-   Add new features (whatever you like, really)
-   Huge parts of the code are kind of a mess to be honest. Feel free to make the code more beautiful :)
-   I'm not very good in design and frontend, so feel free to improve these kind of things too
-   Write more tests for the test suite (which is extremely incomplete at the moment)
-   Write/improve documentation - either in code or in the README, wiki or manuals.

Just remember to pass the test suite and follow the code formatting guidelines (`.clang-format`).

## Contributors :heart:

-   [Marvin Borner](https://github.com/marvinborner/) - Project initiator and main contributor
-   [LarsVomMars](https://github.com/LarsVomMars/) - General help and fixes

## Licenses

Melvix is released under the MIT License and uses parts of the following 3rd party projects:

Inspiration/usage (documented in the respective files):

-   [OSDev wiki](https://wiki.osdev.org) - Very helpful!
-   [James Molloy's tutorials](http://jamesmolloy.co.uk/tutorial_html/)
-   [virtix - tasking inspiration](https://github.com/16Bitt/virtix/) - [MIT License](https://github.com/16Bitt/virtix/blob/85a3c58f3d3b8932354e85a996a79c377139c201/LICENSE)
-   [studix - FS inspiration](https://github.com/orodley/studix) - [MIT License](https://github.com/orodley/studix/blob/d1b1d006010120551df58ff3faaf97484dfa9806/LICENSE)
-   [skiftOS - Memory management inspiration](https://github.com/skiftOS/skift) - [MIT License](https://github.com/skiftOS/skift/blob/ea0e1cf0d7b07302370fc1519be2e072a4cad70c/license.md)
-   [ToAruOS - PCI and network driver inspiration](https://github.com/klange/toaruos) - [NCSA License](https://github.com/klange/toaruos/blob/351d5d38f22b570459931475d36468bf4e37f45a/LICENSE)

Resources:

-   [Spleen font](https://github.com/fcambus/spleen) - [MIT License](https://github.com/fcambus/spleen/blob/5759e9abb130b89ba192edc5324b12ef07b7dad3/LICENSE)
-   [Material icons](https://github.com/Templarian/MaterialDesign/) - [Several Licenses (MIT compliant)](https://github.com/Templarian/MaterialDesign/blob/5772b5e293352e7feed316c4ab6bde3ba572959e/LICENSE)

Libraries:

-   [lodepng (modified)](https://github.com/lvandeve/lodepng) - [ZLIB License](https://github.com/lvandeve/lodepng/blob/7fdcc96a5e5864eee72911c3ca79b1d9f0d12292/LICENSE)
-   [sxml (modified)](https://github.com/capmar/sxml) - [Unlicense License](https://github.com/capmar/sxml/blob/91176b4c62ef7c6342804e02fc440b2e82326469/UNLICENSE)