curds/boredos_mirror
1
0
Fork 0
mirror of https://github.com/BoredDevNL/BoredOS.git synced 2026-05-15 10:48:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

doc: prettier README

Browse source
This commit is contained in:
boreddevnl 2026-05-09 23:43:32 +02:00
parent 3d53e45e20
commit e80f4ba172
1 changed files with 86 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

141
README.md
View file

@ -1,95 +1,126 @@
# BoredOS
<div align="center"> <div align="center">
<img src="branding/bOS_full_gradient_cropped.png" alt="BoredOS Logo" width="450" /> <img src="branding/bOS_full_gradient_cropped.png" alt="BoredOS Logo" width="450" />
<p><em>A modern x86_64 hobbyist operating system built from the ground up.</em></p>
<h3>A modern x86_64 hobbyist operating system built from the ground up.</h3>
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![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) ![Platform: x86_64](https://img.shields.io/badge/Platform-x86_64-lightgrey)
![Status: Active](https://img.shields.io/badge/Status-Active-brightgreen) ![Status: Active](https://img.shields.io/badge/Status-Active-brightgreen)
![GitHub all releases](https://img.shields.io/github/downloads/boreddevnl/BoredOS/total?color=brightgreen) ![GitHub all releases](https://img.shields.io/github/downloads/boreddevnl/BoredOS/total?color=brightgreen)
<br />
[Docs](docs/README.md) · [Build & Run](docs/build/usage.md) · [AppDev SDK](docs/appdev/custom_apps.md) · [Support](https://buymeacoffee.com/boreddevhq)
</div> </div>
--- ---
BoredOS is a x86_64 operating system featuring a custom DE, LwIP networking, SMP, FAT32 filesystem and fully functional userland.
![Screenshot](branding/screenshot.jpg) ![Screenshot](branding/screenshot.jpg)
> [!NOTE] > [!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 ### System Architecture
* **64-bit Long Mode:** Fully utilizing the x86_64 architecture. - **64-bit Long Mode** — fully utilizing x86_64
* **Symmetric Multi-Processing (SMP):** Full support for multi-core CPUs via Limine SMP. - **Symmetric Multi-Processing (SMP)** — multi-core support via Limine
* **LAPIC & IPI Scheduling:** Advanced interrupt handling and inter-processor communication for task distribution. - **LAPIC & IPI Scheduling** — advanced interrupt handling and inter-processor communication
* **SMP-Safe Spinlocks:** Robust kernel-wide synchronization for VFS, process management, and the GUI. - **SMP-Safe Spinlocks** — kernel-wide sync for VFS, processes, and GUI
* **Multiboot2 Compliant:** Bootable on real hardware and modern emulators. - **FAT32 Filesystem** — persistent and in-memory storage
* **Kernel Core:** Interrupt Descriptor Table (IDT) management and a robust syscall interface. - **lwIP Networking** — full TCP/IP stack with a basic browser
* **Filesystem:** Full **FAT32** support for persistent and in-memory storage. - **Multiboot2 Compliant** — runs on real hardware and emulators
* **Networking:** Includes the lwIP networking stack and a basic web browser.
### Graphical User Interface ### Graphical Interface
* **BoredWM:** A custom Window Manager with drag-and-drop, mouse-centered interaction. - **BoredWM** — custom window manager with drag-and-drop
* **Customization:** Adjustable UI to suit your aesthetic. - **Media support** — PNG, GIF, JPEG, TGA, BMP decoding
* **Media Support:** Built-in image decoding. (PNG, GIF, JPEG, TGA, BMP)
### Included Applications ### Included Applications
* **Productivity:** GUI Text Editor calculator, Markdown Viewer, a simple browser and BoredWord. | Category | Apps |
* **Creativity:** A Paint application. |----------|------|
* **Utilities:** Terminal, Task Manager, File Explorer, Clock and a (limited) C Compiler. | Productivity | Text Editor, Calculator, Markdown Viewer, BoredWord, Browser |
* **Games:** Minesweeper and DOOM. | Creativity | Paint |
| Utilities | Terminal, Task Manager, Files, Clock, TCC, Grapher etc. |
| Games | Minesweeper, DOOM, 2048, snake |
</td>
</tr>
</table>
--- ---
## 📚 Documentation ## 📚 Documentation
Explore the internal workings of BoredOS via our comprehensive guides in the [`docs/`](docs/) directory. | Guide | Description |
|-------|-------------|
* **[Documentation Index](docs/README.md)** – Start here. | [Documentation Index](docs/README.md) | Start here! |
* **[Architecture Overview](docs/architecture/core.md)** – Deep dive into the kernel. | [Architecture Overview](docs/architecture/core.md) | Deep dive into the kernel |
* **[Building and Running](docs/build/usage.md)** – Setup your build environment. | [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. | [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!
<a href="https://buymeacoffee.com/boreddevhq" target="_blank">
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="50" style="border-radius: 8px;" />
</a>
--- ---
## Contributors ## Contributors
- **BoredDevNL** — Project creator and lead maintainer. <table>
- **Lluciocc** — Contributor. <tr>
- **Artemix1508** - Artworks. <td align="center">
<a href="https://github.com/boreddevnl">
## Project Disclaimer & Heritage <img src="https://github.com/boreddevnl.png?size=80" width="60" /><br />
<sub><b>BoredDevNL</b></sub>
**BoredOS** is the successor to **[BrewKernel](https://github.com/boreddevnl/brewkernel)**, a project initiated in 2023. </a><br />
Creator & Lead Maintainer
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. </td>
<td align="center">
> [!IMPORTANT] <a href="https://github.com/Lluciocc">
> 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. <img src="https://github.com/Lluciocc.png?size=80" width="60" /><br />
<sub><b>Lluciocc</b></sub>
</a><br />
Contributor
</td>
<td align="center">
<a href="https://github.com/Artemix1508">
<img src="https://github.com/Artemix1508.png?size=80" width="60" /><br />
<sub><b>Artemix1508</b></sub>
</a><br />
Artwork
</td>
</tr>
</table>
--- ---
## ☕ Support the Journey
If you find BoredOS interesting or useful, consider fueling development with a coffee!
<a href="https://buymeacoffee.com/boreddevhq" target="_blank">
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="50" style="border-radius: 8px;" />
</a>
---
## 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 ## 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] > [!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.