From e80f4ba1728979a297d69a20524e381362120270 Mon Sep 17 00:00:00 2001 From: boreddevnl Date: Sat, 9 May 2026 23:43:32 +0200 Subject: [PATCH] doc: prettier README --- README.md | 141 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 86 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 30d3361..0fb8543 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,126 @@ -# BoredOS -
BoredOS Logo -

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

+ +

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/custom_apps.md) · [Support](https://buymeacoffee.com/boreddevhq) +
--- -BoredOS is a x86_64 operating system featuring a custom DE, LwIP networking, SMP, FAT32 filesystem and fully functional userland. - ![Screenshot](branding/screenshot.jpg) + > [!NOTE] -> *The screenshot above may represent a previous build and is subject to change as the UI evolves.* +> The screenshot above may represent a previous build and is subject to change as the UI evolves. --- -## Features +## ✨ Features ### System Architecture -* **64-bit Long Mode:** Fully utilizing the x86_64 architecture. -* **Symmetric Multi-Processing (SMP):** Full support for multi-core CPUs via Limine SMP. -* **LAPIC & IPI Scheduling:** Advanced interrupt handling and inter-processor communication for task distribution. -* **SMP-Safe Spinlocks:** Robust kernel-wide synchronization for VFS, process management, and the GUI. -* **Multiboot2 Compliant:** Bootable on real hardware and modern emulators. -* **Kernel Core:** Interrupt Descriptor Table (IDT) management and a robust syscall interface. -* **Filesystem:** Full **FAT32** support for persistent and in-memory storage. -* **Networking:** Includes the lwIP networking stack and a basic web browser. +- **64-bit Long Mode** — fully utilizing x86_64 +- **Symmetric Multi-Processing (SMP)** — multi-core support via Limine +- **LAPIC & IPI Scheduling** — advanced interrupt handling and inter-processor communication +- **SMP-Safe Spinlocks** — kernel-wide sync for VFS, processes, and GUI +- **FAT32 Filesystem** — persistent and in-memory storage +- **lwIP Networking** — full TCP/IP stack with a basic browser +- **Multiboot2 Compliant** — runs on real hardware and emulators -### Graphical User Interface -* **BoredWM:** A custom Window Manager with drag-and-drop, mouse-centered interaction. -* **Customization:** Adjustable UI to suit your aesthetic. -* **Media Support:** Built-in image decoding. (PNG, GIF, JPEG, TGA, BMP) +### Graphical Interface +- **BoredWM** — custom window manager with drag-and-drop +- **Media support** — PNG, GIF, JPEG, TGA, BMP decoding ### Included Applications -* **Productivity:** GUI Text Editor calculator, Markdown Viewer, a simple browser and BoredWord. -* **Creativity:** A Paint application. -* **Utilities:** Terminal, Task Manager, File Explorer, Clock and a (limited) C Compiler. -* **Games:** Minesweeper and DOOM. +| Category | Apps | +|----------|------| +| Productivity | Text Editor, Calculator, Markdown Viewer, BoredWord, Browser | +| Creativity | Paint | +| Utilities | Terminal, Task Manager, Files, Clock, TCC, Grapher etc. | +| Games | Minesweeper, DOOM, 2048, snake | + + + + --- + + ## 📚 Documentation -Explore the internal workings of BoredOS via our comprehensive guides in the [`docs/`](docs/) directory. - -* **[Documentation Index](docs/README.md)** – Start here. -* **[Architecture Overview](docs/architecture/core.md)** – Deep dive into the kernel. -* **[Building and Running](docs/build/usage.md)** – Setup your build environment. -* **[AppDev SDK](docs/appdev/custom_apps.md)** – Build your own apps for BoredOS. - ---- - -## Support the Journey - -If you find this project interesting or helpful, consider fueling the development with a coffee! - - - Buy Me A Coffee - - +| Guide | Description | +|-------|-------------| +| [Documentation Index](docs/README.md) | Start here! | +| [Architecture Overview](docs/architecture/core.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 -- **BoredDevNL** — Project creator and lead maintainer. -- **Lluciocc** — Contributor. -- **Artemix1508** - Artworks. - -## Project Disclaimer & Heritage - -**BoredOS** is the successor to **[BrewKernel](https://github.com/boreddevnl/brewkernel)**, a project initiated in 2023. - -While BrewKernel served as the foundational learning ground for this OS, it has been officially **deprecated and archived**. It no longer receives updates, bug fixes, or pull request reviews. BoredOS represents a complete architectural reboot, applying years of lessons learned to create a cleaner, more modular, and more capable system. - -> [!IMPORTANT] -> Please ensure all issues, discussions, and contributions are directed to this repository. Legacy BrewKernel code is preserved for historical purposes only and is not compatible with BoredOS. + + + + + + +
+ +
+ BoredDevNL +
+ Creator & Lead Maintainer + 		+ +
+ Lluciocc +
+ Contributor + 		+ +
+ Artemix1508 +
+ Artwork +
--- +## ☕ 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** +**Copyright (C) 2023–2026 boreddevnl** -Distributed under the **GNU General Public License v3**. See the `LICENSE` file for details. +Distributed under the **GNU General Public License v3**. See [`LICENSE`](LICENSE) for details. > [!IMPORTANT] -> This product includes software developed by Chris ("boreddevnl"). You must retain all copyright headers and include the original attribution in any redistributions or derivative works. See the `NOTICE` file for more details. +> 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. \ No newline at end of file