Skip to content

Commit 4b10a0d

Browse files
committed
updated screenshots, included a demo run, and updated the README
1 parent 9e40671 commit 4b10a0d

File tree

5 files changed

+47
-4
lines changed

5 files changed

+47
-4
lines changed

README.md

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
* [Prerequisites](#bangbang-prerequisites)
7575
* [Building and Running](#hammer_and_wrench-building-and-running-the-project)
7676
* [Debugging](#wrench-debugging)
77-
* [Baremetal Debugging](#wrench-debugging)
77+
* [Baremetal Debugging](#wrench-baremetal-debugging)
7878
- [Contributing](#wave-contributing)
7979
- [License](#newspaper-license)
8080
- [Acknowledgements](#gem-acknowledgements)
@@ -101,11 +101,32 @@ when it actually happened.
101101
### :camera: Screenshots
102102

103103
<div align="center">
104-
<img src="screenshots/stellux-run.png" alt="screenshot" />
104+
<img src="screenshots/stellux_run_splash.png" alt="StelluxOS Splash Screen" width="45%" />
105+
<img src="screenshots/stellux_run_desktop.png" alt="StelluxOS Desktop" width="45%" />
105106
<br/>
106107
<img src="screenshots/stellux-xhci-run.png" alt="screenshot" />
107108
</div>
108109

110+
<!-- Supported Architectures -->
111+
### :desktop_computer: Supported Architectures
112+
113+
<div align="center">
114+
<table>
115+
<tr>
116+
<th>Architecture</th>
117+
<th>Status</th>
118+
<th>Notes</th>
119+
</tr>
120+
<tr>
121+
<td><b>x86_64</b></td>
122+
<td>✅ <b>Fully Supported</b></td>
123+
<td>Primary development target with full feature support</td>
124+
</tr>
125+
</table>
126+
</div>
127+
128+
*StelluxOS is currently optimized for x86_64 systems with modern UEFI firmware. Support for additional architectures is planned for future releases.*
129+
109130
<!-- Features -->
110131
### :dart: Features
111132

@@ -119,11 +140,17 @@ when it actually happened.
119140
- HPET and time management support
120141
- Stacktrace dump from the _interrupt_ context
121142
- Kernel module subsystem allowing daemons and drivers to be spawned easily
122-
- Xhci driver module for USB stack support
143+
- xHCI driver for USB stack support
144+
- HID drivers for modern USB keyboards and mice
123145
- Unit testing framework integrated with Github Actions CI pipeline
124146
- VFS and RAM filesystem support
125147
- GDB server stub for low-level kernel debugging, including breakpoint and memory
126148
inspection support on baremetal
149+
- Display manager with compositor utilizing triple-buffer rendering, framebuffer management, and input handling
150+
- Userland applications with musl libc integration for POSIX compatibility
151+
- Custom stlibc library providing Stellux-specific functionality
152+
- Terminal emulator with ANSI escape sequence support and built-in command processing
153+
- Graphics library (libstlxgfx) for window management and event handling (Undergoing improvements)
127154

128155
<!-- Getting Started -->
129156
## :gear: Getting Started
@@ -134,13 +161,29 @@ when it actually happened.
134161
Clone the repository
135162
```bash
136163
git clone https://github.com/FlareCoding/StelluxOS.git
164+
cd StelluxOS
137165
```
138166

139-
Install dependencies
167+
Install system dependencies
140168
```bash
141169
make install-dependencies
142170
```
143171

172+
Build the custom toolchain for userspace applications
173+
```bash
174+
cd toolchain/scripts
175+
source env.sh
176+
./fetch-sources.sh
177+
./build-toolchain.sh
178+
cd ../..
179+
```
180+
181+
*Note: The custom toolchain is required for building userspace applications. The toolchain includes:*
182+
- *binutils 2.43*
183+
- *GCC 14.3.0*
184+
- *musl libc 1.2.5*
185+
- *Target: x86_64-linux-musl*
186+
144187
<!-- Building and Running the Project -->
145188
### :hammer_and_wrench: Building and Running the Project
146189

1.49 MB
Binary file not shown.

screenshots/stellux-run.png

-17 KB
Binary file not shown.
122 KB
Loading

screenshots/stellux_run_splash.png

201 KB
Loading

0 commit comments

Comments
 (0)