Initial commit: SkyOS source code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-07-23 12:14:34 -04:00
commit e641720a3c
@@ -0,0 +1,79 @@
+# Installing SkyOS on an Intel Mac
+
+## Before you start
+
+- Intel Mac (any MacBook/MacBook Pro with Intel CPU — 2006–2020)
+- USB drive ≥ 4 GB
+- The SkyOS ISO
+
+## Step 1 — Boot from USB
+
+Intel Macs use EFI + rEFInd (included in the ISO) to boot Linux.
+
+1. Hold **Option (⌥)** at startup to see the boot picker.
+2. Select the SkyOS USB drive (shows as "EFI Boot").
+
+## Step 2 — Partition the disk
+
+In the live environment, run `cfdisk /dev/sda` (replace with your disk):
+
+| Partition | Size         | Type             | Mount     |
+|-----------|-------------|------------------|-----------|
+| sda1      | 512 MB      | EFI System       | /boot/efi |
+| sda2      | 4 GB        | Linux swap       | swap      |
+| sda3      | remainder   | Linux filesystem | /         |
+
+Format:
+```bash
+mkfs.fat -F32 /dev/sda1
+mkswap /dev/sda2
+mkfs.ext4 -L SkyOS /dev/sda3
+```
+
+## Step 3 — Install
+
+```bash
+mount /dev/sda3 /mnt
+mkdir -p /mnt/boot/efi
+mount /dev/sda1 /mnt/boot/efi
+swapon /dev/sda2
+
+pacstrap /mnt base linux linux-firmware ...  # (handled by build-base.sh)
+genfstab -U /mnt >> /mnt/etc/fstab
+```
+
+## Step 4 — rEFInd for Mac EFI
+
+Intel Macs need rEFInd instead of GRUB for reliable EFI booting:
+
+```bash
+arch-chroot /mnt
+refind-install
+```
+
+rEFInd auto-detects the kernel; our config at `/boot/EFI/refind/refind.conf`
+points it at the right initramfs.
+
+## Step 5 — First boot
+
+Log in as `sky` (password: `skyos` — change it!), then:
+
+```bash
+startx
+```
+
+The SkyWM desktop launches with the Deskbar in the top-right corner.
+
+## Intel Mac hardware notes
+
+| Hardware        | Status   | Notes                                  |
+|-----------------|----------|----------------------------------------|
+| WiFi (Broadcom) | Works    | `broadcom-wl-dkms` DKMS driver        |
+| Intel iGPU      | Works    | `xf86-video-intel` or modesetting     |
+| Discrete GPU    | Partial  | AMD: works; Nvidia: use `nouveau`      |
+| Trackpad        | Works    | `xf86-input-libinput` with gestures   |
+| Audio           | Works    | `alsa-utils` + `snd_hda_intel`        |
+| Suspend/Resume  | Mostly   | `echo mem > /sys/power/state`         |
+| Keyboard backlit| Works    | `/sys/class/leds/` brightness control |
+| Webcam          | Works    | UVC driver built into kernel          |
+| Thunderbolt     | Partial  | TB1/2: limited; TB3+: better          |