diff --git a/README.md b/README.md index 30d3361..0fb8543 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,126 @@ -# BoredOS -
- A modern x86_64 hobbyist operating system built from the ground up.
+ +
-
-
+| 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 + |
+
+
+
+---
+
+## 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