From d01c30916634fda96d965deea862cf0669d0085f Mon Sep 17 00:00:00 2001 From: boreddevnl Date: Mon, 16 Mar 2026 00:34:24 +0100 Subject: [PATCH] updated readme --- README.md | 84 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 68 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index e39dd3e..5601d8a 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,35 @@ -# Bored OS 1.50 +# BoredOS -BoredOS is now in a Beta stage as i have brought over all apps from boredkernel and have made the DE a lot more usable and stable. -## Boredkernel is now BoredOS! -Boredkernel will from now on be deprecated as it's core became too messy. I have built a less bloated kernel and wrote a DE above it, which is why it is now an OS instead of a kernel (in my opinion). - -Bored Kernel is a simple x86_64 hobbyist operating system. +
+ BoredOS Logo +
+BoredOS is a simple x86_64 hobbyist operating system. It features a DE (and WM), a FAT32 filesystem, customizable UI and much much more! +![Screenshot](screenshot.jpg) +*this screenshot might be outdated* + ## Features +- userspace +- JPG image support +- Disk manager +- Drag and drop mouse centered UI +- Customizable UI +- Basic Networking Stack - Bored WM -- Fat 32 FS +- FAT32 filesystem - 64-bit long mode support - Multiboot2 compliant - Text editor +- Markdown Viewer +- Minesweeper +- Markdown Viewer +- GUI Text editor +- Paint application - IDT - Ability to run on actual x86_64 hardware - CLI +- (Limited) C Compiler ## Prerequisites @@ -76,18 +90,30 @@ qemu-system-x86_64 -m 2G -serial stdio -cdrom boredos.iso -boot d 3. **Boot**: Insert the USB drive and select it in the boot menu during startup +**Networking requires an Intel E1000 network card or similar while using Ethernet.** + 4. **Tested Hardware**: - - HP EliteDesk 705 G4 DM (AMD Ryzen 5 PRO 2400G, Radeon Vega) - - Lenovo ThinkPad A475 20KL002VMH (AMD Pro A12-8830B, Radeon R7) + - HP EliteDesk 705 G4 DM (AMD Ryzen 5 PRO 2400G, Radeon Vega) **Tested, no networking.** + - Lenovo ThinkPad A475 20KL002VMH (AMD Pro A12-8830B, Radeon R7) **Tested, no networking.** + - Acer Aspire E5-573-311M (Intel Core i3-5005U, Intel HD Graphics) **Tested, no networking.** + ## Project Structure -- `src/kernel/` - Main kernel implementation - - `boot.asm` - Boot assembly code - - `main.c` - Kernel entry point - - `*.c / *.h` - Core kernel modules (graphics, interrupts, filesystem, etc.) - - `cli_apps/` - Command-line applications - - `wallpaper.ppm` - Default desktop wallpaper +- `src/` - Main OS codebase + - `arch/` - Assembly bootstrap and interrupt architectures + - `core/` - Initialization, commands, system panic + - `dev/` - PCI, disk manager, inputs, and RTC + - `fs/` - Physical and virtual filesystems (FAT32) + - `mem/` - Memory management, paging, and VM + - `net/` - Networking stack, interface controllers, and `lwip/` + - `sys/` - System calls, process management, and ELF loader + - `wm/` - Graphics, user interface, fonts, and window manager + - `userland/` - End-user applications and tools + - `cli/` - Standard command line applications + - `gui/` - Graphical applications + - `games/` - Games such as DOOM and Minesweeper + - `sys/` - Userland system tools and network clients - `build/` - Compiled object files (generated during build) - `iso_root/` - ISO filesystem layout (generated during build) - `limine/` - Limine bootloader files (downloaded automatically) @@ -95,6 +121,32 @@ qemu-system-x86_64 -m 2G -serial stdio -cdrom boredos.iso -boot d - `limine.conf` - Limine bootloader configuration - `Makefile` - Build configuration and targets + + + +### +### + +

Help me brew some coffee! ☕️

+ +### + +

+ If you enjoy this project, and like what i'm doing here, consider buying me a coffee! +

+ + Buy Me A Coffee + +

+ +### + + +## This project was previously labeled as "BrewKernel" +Brewkernel was a text only very simple (and messy) project i started 3 years ago. It was my first work in OSDev and i absolutely loved it. It sadly just got too messy and i myself couldn't understand my own code anymore. About a year ago i started work on BoredOS, and pushed a *"working"* version of it a few days ago as of writing this *(Feb. 10 2026)* +Brewkernel has already been deprecated and will not be accepting any pull requests or fix any issues as it is now a public archive. +Thanks to everyone who helped me with Brewkernel, even if it were just ideas, and intend to keep working on this for the forseeable future! + ## License Copyright (C) 2024-2026 boreddevnl @@ -104,7 +156,7 @@ This program is free software: you can redistribute it and/or modify it under th NOTICE ------ -This product includes software developed by Chris ("boreddevnl") as part of the BoredOS project. +This product includes software developed by Chris ("boreddevnl") as part of the BoredOS (Previously Brewkernel/BrewOS) project. Copyright (C) 2024–2026 Chris / boreddevnl (previously boreddevhq)