dollspace.gay
Microkernel based hobby OS
documentation fixes
dollspacegay.tngl.sh
+64
-24
+2
-2
CLAUDE.md
+2
-2
CLAUDE.md
···
20
20
21
21
### Build Commands
22
22
23
-
**From project root (`aethelos-source/`):**
23
+
**From project root:**
24
24
25
25
```bash
26
26
# 1. Build the kernel
···
40
40
41
41
**Quick rebuild workflow (one-liner with error checking):**
42
42
```bash
43
-
cd /f/OS/aethelos-source/heartwood && cargo build --bin heartwood --target x86_64-aethelos.json 2>&1 | grep -E "(Finished|error)" && cd .. && wsl bash -c "cp target/x86_64-aethelos/debug/heartwood isodir/boot/aethelos/heartwood.bin && grub-mkrescue -o aethelos.iso isodir 2>&1 | grep success"
43
+
cd heartwood && cargo build --target x86_64-aethelos.json 2>&1 | grep -E "(Finished|error)" && cd .. && wsl bash -c "cp target/x86_64-aethelos/debug/heartwood isodir/boot/aethelos/heartwood.bin && grub-mkrescue -o aethelos.iso isodir 2>&1 | grep success"
44
44
```
45
45
46
46
**Note:** This filters output to show only build status and ISO creation success, making it faster to spot issues.
+62
-22
README.md
+62
-22
README.md
···
83
83
## Project Structure
84
84
85
85
```
86
-
aethelos-source/
86
+
aethelos/ # Project root
87
87
├── GENESIS.scroll # Philosophical and architectural overview
88
+
├── DESIGN.md # Design philosophy and principles
89
+
├── ARCHITECTURE.txt # Technical architecture notes
90
+
├── CLAUDE.md # AI assistant development guide
91
+
├── README.md # This file
88
92
├── Cargo.toml # Workspace configuration
93
+
├── rust-toolchain.toml # Rust version specification
94
+
├── BOOT_AETHELOS.bat # Windows boot script
89
95
│
90
96
├── awakening/ # Bootloader
91
97
│ ├── boot.asm # First stage (assembly)
92
98
│ └── heartwood_loader/ # Second stage (Rust)
93
99
│
94
100
├── heartwood/ # The Kernel
95
-
│ ├── nexus/ # IPC system
96
-
│ ├── loom-of-fate/ # Scheduler
97
-
│ ├── mana-pool/ # Memory management
98
-
│ └── attunement/ # Hardware abstraction
101
+
│ ├── src/
102
+
│ │ ├── main.rs # Kernel entry point
103
+
│ │ ├── lib.rs # Kernel library
104
+
│ │ ├── nexus/ # IPC system (module)
105
+
│ │ ├── loom_of_fate/ # Scheduler (module)
106
+
│ │ ├── mana_pool/ # Memory management (module)
107
+
│ │ ├── attunement/ # Hardware abstraction (module)
108
+
│ │ ├── boot/ # Boot code (Multiboot2)
109
+
│ │ ├── eldarin.rs # Interactive shell
110
+
│ │ ├── vga_buffer.rs # VGA text mode driver
111
+
│ │ └── irq_safe_mutex.rs # Interrupt-safe synchronization
112
+
│ ├── Cargo.toml # Kernel package configuration
113
+
│ ├── x86_64-aethelos.json # Custom target specification
114
+
│ └── linker.ld # Linker script
99
115
│
100
-
├── groves/ # User-space services
101
-
│ ├── world-tree_grove/ # Filesystem
102
-
│ ├── the-weave_grove/ # Compositor
103
-
│ ├── lanthir_grove/ # Window manager
116
+
├── groves/ # User-space services (skeletal)
117
+
│ ├── world-tree_grove/ # Filesystem service
118
+
│ ├── the-weave_grove/ # Compositor service
119
+
│ ├── lanthir_grove/ # Window manager service
104
120
│ └── network_sprite/ # Network daemon
105
121
│
106
-
└── ancient-runes/ # Core libraries
107
-
├── corelib/ # Standard library
108
-
├── weaving/ # GUI toolkit
109
-
└── script/ # Shell API
122
+
├── ancient-runes/ # Core libraries (skeletal)
123
+
│ ├── corelib/ # Standard library
124
+
│ ├── weaving/ # GUI toolkit
125
+
│ └── script/ # Shell scripting API
126
+
│
127
+
├── docs/ # Architecture and planning documents
128
+
│ ├── PREEMPTIVE_MULTITASKING_PLAN.md
129
+
│ ├── VGA_GRAPHICS_MODE_PLAN.md
130
+
│ ├── WORLD_TREE_PLAN.md
131
+
│ ├── GLIMMER_FORGE_PLAN.md
132
+
│ └── PRODUCTION_READINESS_PLAN.md
133
+
│
134
+
└── isodir/ # ISO build directory
135
+
└── boot/
136
+
├── grub/ # GRUB configuration
137
+
│ └── grub.cfg
138
+
└── aethelos/ # Kernel binary location
139
+
└── heartwood.bin
110
140
```
111
141
112
142
## Building and Running
···
121
151
### Build Commands
122
152
123
153
```bash
124
-
# Build the kernel (from heartwood directory)
154
+
# Build the kernel (from project root)
125
155
cd heartwood
126
-
cargo build --bin heartwood --target x86_64-aethelos.json
156
+
cargo build --target x86_64-aethelos.json
127
157
128
-
# Create bootable ISO (from aethelos-source root)
129
-
cp target/x86_64-aethelos/debug/heartwood isodir/boot/aethelos/heartwood.bin
130
-
grub-mkrescue -o aethelos.iso isodir
158
+
# Create bootable ISO (from project root, requires WSL/Linux)
159
+
cd ..
160
+
wsl bash -c "cp target/x86_64-aethelos/debug/heartwood isodir/boot/aethelos/heartwood.bin && grub-mkrescue -o aethelos.iso isodir"
161
+
162
+
# Run in QEMU (Windows)
163
+
"C:\Program Files\qemu\qemu-system-x86_64.exe" -cdrom aethelos.iso -serial file:serial.log -m 256M -display gtk -no-reboot -no-shutdown
131
164
132
-
# Run in QEMU
133
-
qemu-system-x86_64 -cdrom aethelos.iso -serial file:serial.log -m 256M
165
+
# Run in QEMU (Linux/macOS)
166
+
qemu-system-x86_64 -cdrom aethelos.iso -serial file:serial.log -m 256M -display gtk -no-reboot -no-shutdown
134
167
```
135
168
136
169
### Windows Build Script
137
170
171
+
Use the provided `BOOT_AETHELOS.bat` script:
172
+
138
173
```cmd
139
174
@echo off
175
+
REM Build kernel
140
176
cd heartwood
141
-
cargo build --bin heartwood --target x86_64-aethelos.json
177
+
cargo build --target x86_64-aethelos.json
142
178
cd ..
179
+
180
+
REM Create ISO
143
181
wsl bash -c "cp target/x86_64-aethelos/debug/heartwood isodir/boot/aethelos/heartwood.bin && grub-mkrescue -o aethelos.iso isodir"
144
-
"C:\Program Files\qemu\qemu-system-x86_64.exe" -cdrom aethelos.iso -m 256M
182
+
183
+
REM Boot in QEMU
184
+
"C:\Program Files\qemu\qemu-system-x86_64.exe" -cdrom aethelos.iso -serial file:serial.log -m 256M -display gtk -no-reboot -no-shutdown
145
185
```
146
186
147
187
## Key Innovations