diff --git a/README.md b/README.md index 3c890c21..c0639afb 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,45 @@ -# ABOUT GHOST -**Ghost** is a hobbyist operating system for the x86-64 platform. -The OS is written from scratch in C/C++ and Assembly. +# ABOUT SEOS -This is the main development repository. +SeOs (Sea Operating System) is a hobbyist x86-64 operating system written in C/C++ and Assembly. This project is a custom fork derived from the **Ghost operating system by Max Schlüssel (@maxdev1)**, featuring enhancements in service management and desktop aesthetics. -**Project website:** http://ghostkernel.org/ +Main development repository by **seamiq** (GitHub: [seamiq](https://github.com/ddd800938-hue) / ddd800938-hue). -## Documentation -See the `documentation` folder. It contains information about the technical design as well as detailed building instructions. - -A usually up-to-date version of the documentation is provided here: https://ghostkernel.org/documentation/ - -## Live ISO +## 🌊 Key Enhancements & Features -If you just want to play around with the latest state, you can download an ISO -image from the [release section](https://github.com/maxdev1/ghost/releases). +* **Custom Service Supervision (runit-like):** Lightweight init/service system for better process management and crash recovery. +* **Refined GUI & Taskbar:** Improved, responsive user interface. +* **Animated Wave Wallpaper:** Custom desktop background engine. -The suggested way to test it is in VirtualBox with at least 512MB of RAM and the -VMSVGA graphics adapter enabled for better performance. +## Core Architecture Features +* x86_64-based micro-kernel with SMP support. +* `libapi` & custom C standard library (`libc`). +* OS-specific GCC toolchain & ELF support. +* Window server (`fenster`) & GUI toolkit. +* Drivers for VESA/VBE, PS/2, and PCI. +* Limine protocol compliant. -## Quick-start +## Ported Software +* `libpng`, `pixman`, `zlib`, `cairo`, `freetype`. +* `musl` (for `libm` in `libc`). -1. On your host machine (where Docker is installed), run `./docker-build-toolchain-image.sh`. This will - build an image that contains the cross-compiler and other tools required for building the operating system. -2. Once the process has finished, it will open a bash within the container. The container has this repository folder mounted to `/ghost/source`. -3. Build the operating system by running `./build.sh` in that directory within the container. - -Afterwards, the `target` folder will contain the bootable ISO image. +## Documentation +See the `documentation` folder for technical design and build instructions. -## Features -* x86_64-based micro-kernel -* SMP multi-processor support -* Comprehensive kernel interaction library (libapi) -* Own C standard library (libc) -* OS-specific GCC toolchain -* ELF binary & shared library support -* Window server & toolkit -* Support for C++ in kernel & userland -* Various interprocess-communication methods -* Drivers for - * VESA/VBE video output - * PS/2 keyboard & mouse - * PCI handling -* Limine protocol compliance -* It's also very cool +## Live ISO +Downloadable from the releases section. Test in VirtualBox (512MB+ RAM, EFI enabled, VMSVGA graphics). -The OS uses the [fenster windowserver](https://github.com/maxdev1/fenster) which originated from this project: +## Quick-start & Docker Compilation Warning -![Screenshot of 0.12.0](https://ghostkernel.org/files/ghost-0.22.2.png) +The build system relies on Docker containers. -## Ported software -* libpng -* pixman -* zlib -* cairo -* freetype -* musl (provides libm part of Ghost libc) +> ⚠️ **Important Note on Docker:** +> Due to regional connectivity and registry issues with Docker in Russia, the Docker-based build system **has not been personally tested by the author**. +> +> While scripts (`./docker-build-toolchain-image.sh` and `./build.sh`) are included, **you may encounter unexpected build errors**. Feedback and PRs regarding the Docker toolchain are welcome! -## Contact -If you want to get in contact, contribute to the project or have any questions, -feel free to contact me at: +1. Run `./docker-build-toolchain-image.sh` to build the toolchain image. +2. Inside the container (mounted at `/seos/source`), run `./build.sh`. +3. The `target` folder will contain the bootable ISO. - lokoxe@gmail.com - --Max Schlüssel +## Acknowledgements +SeOs is proudly derived from the **Ghost operating system** developed by **Max Schlüssel** (@maxdev1).