From 16eedb752fa530ced9e26e9cdb434a729508dd1d Mon Sep 17 00:00:00 2001 From: boreddevnl Date: Tue, 12 May 2026 14:30:28 +0200 Subject: [PATCH] doc: update contributors list --- README.md | 119 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 119 insertions(+) diff --git a/README.md b/README.md index 39bce0e..01948ab 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,77 @@ +## ๐Ÿ“š Documentation + +| Guide | Description | +|-------|-------------| +| [Documentation Index](docs/README.md) | Start here! | +| [Architecture Overview](docs/architecture/README.md) | Deep dive into the kernel | +| [Building and Running](docs/build/usage.md) | Set up your build environment | +| [AppDev SDK](docs/appdev/custom_apps.md) | Build your own apps for BoredOS | + +--- + +## Contributors + +
+ BoredOS Logo + +

A modern x86_64 hobbyist operating system built from the ground up.

+ + [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) + ![Platform: x86_64](https://img.shields.io/badge/Platform-x86_64-lightgrey) + ![Status: Active](https://img.shields.io/badge/Status-Active-brightgreen) + ![GitHub all releases](https://img.shields.io/github/downloads/boreddevnl/BoredOS/total?color=brightgreen) + +
+ + [Docs](docs/README.md) ยท [Build & Run](docs/build/usage.md) ยท [AppDev SDK](docs/appdev/sdk_reference.md) ยท [Discord](https://discord.gg/J2BxWaFAgY) ยท [Support](https://buymeacoffee.com/boreddevhq) + +
+ +--- + +![Screenshot](branding/screenshot.jpg) + +> [!NOTE] +> The screenshot above may represent a previous build and is subject to change as the UI evolves. + +--- + +## Features + +### Kernel and Architecture +- **Long Mode Architecture** โ€” Native x86_64 implementation utilizing 64-bit address space and registers +- **Symmetric Multi-Processing** โ€” Scalable multi-core support with IPI-based scheduling and synchronization +- **Advanced Memory Management** โ€” Custom slab allocator with object pooling and efficient physical/virtual page mapping +- **Hybrid VFS Layer** โ€” Unified filesystem interface supporting FAT32, TAR, ProcFS, and SysFS +- **Preemptive Multitasking** โ€” Prioritized process scheduling with full context isolation +- **Hardware Abstraction** โ€” Comprehensive driver support for PCI, AHCI, PS/2, and ACPI + +### Graphical Desktop Environment +- **BoredWM** โ€” High-performance window manager featuring window stacking, focus management, and drag-and-drop interactions +- **Typography Engine** โ€” Integrated font manager with TrueType (TTF) support and efficient glyph caching +- **Rich Media Subsystem** โ€” Native hardware-independent decoding for PNG, JPEG, GIF, BMP, and TGA formats +- **LibWidget Toolkit** โ€” Native UI component library for rapid application development + +### Networking Stack +- **TCP/IP Integration** โ€” Full lwIP-based network stack featuring DHCP, DNS, and Berkeley-style sockets +- **Network Services** โ€” Integrated support for basic web browsing and real-time network telemetry + +### Application Ecosystem +| Category | Applications | +|----------|--------------| +| Productivity | Text Editor, Markdown Viewer, BoredWord Processor, Web Browser, Calculator | +| Development | TCC (Tiny C Compiler), Lua| +| System | Explorer (File Manager), Task Manager, System Monitor, Graphing Utility | +| Games | doomgeneric, Minesweeper, 2048, Snake | + + +--- + + + ## ๐Ÿ“š Documentation | Guide | Description | @@ -99,6 +170,8 @@
Artwork + +
@@ -113,6 +186,20 @@
Artwork + + +
+ pixelyblah +
+ Artwork + + + +
+ qwroffc +
+ Artwork + @@ -147,3 +234,35 @@ Distributed under the **GNU General Public License v3**. See [`LICENSE`](LICENSE > [!IMPORTANT] > You must retain all copyright headers and include the original attribution in any redistributions or derivative works. See the [`NOTICE`](NOTICE) file for more details. + +--- + +## โ˜• Support the Journey + +If you find BoredOS interesting or useful, consider fueling development with a coffee! + + + Buy Me A Coffee + + +--- + +## History + +**BoredOS** is the successor to **[BrewKernel](https://github.com/boreddevnl/brewkernel)**, a project started in 2023. BrewKernel served as the foundational learning ground but has since been officially deprecated and archived โ€” it no longer receives updates, bug fixes, or pull request reviews. + +BoredOS is a complete architectural reboot, applying years of lessons learned to build a cleaner, more modular, and more capable system. + +> [!IMPORTANT] +> Please direct all issues, discussions, and contributions to this repository. Legacy BrewKernel code is preserved for historical purposes only and is not compatible with BoredOS. + +--- + +## License + +**Copyright (C) 2023โ€“2026 boreddevnl** + +Distributed under the **GNU General Public License v3**. See [`LICENSE`](LICENSE) for details. + +> [!IMPORTANT] +> You must retain all copyright headers and include the original attribution in any redistributions or derivative works. See the [`NOTICE`](NOTICE) file for more details.