detached 3bab1d4

docs(readme): rewrite for clarity and concision

commit
3bab1d4f9682b6c197ce978bd918a5d4e0434cd2
author
brice · · 2026-04-04 04:38 UTC
parent
1d14b12
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
1 file · +16 -22
Unified
UnifiedSplit
M README.md +16 -22
@@ -2,30 +2,30 @@
22 <img src="assets/archup-logo-v2-5.png" alt="ArchUp Logo" width="600">
33 </p>
44
5-## What Is ArchUp?
5+ArchUp is an opinionated Arch Linux installer that picks the boring defaults so you don't have to.
66
7-ArchUp is an Arch Linux installer similar to archinstall but it makes the choices for you on the boring parts. The difference with Omarchy is that it's not enforcing any dotfile or app. The goal is to install Arch as fast as possible with sane defaults.
7+## What It Decides
88
9-**What it decides for you:**
109 - Btrfs with `@` and `@home` subvolumes
1110 - Limine bootloader (UEFI only)
12-- Chaotic-AUR enabled out of the box
11+- Chaotic-AUR enabled
1312 - Plymouth boot splash
1413 - Snapper for snapshot-based rollbacks
1514 - NetworkManager, OpenSSH, zram, firewalld
1615
17-**What you choose:**
16+## What You Choose
17+
1818 - Disk and optional LUKS2 encryption
1919 - Hostname, user, locale, timezone, keymap
20-- Kernel (linux, linux-lts, linux-zen, linux-hardened, linux-cachyos)
20+- Kernel: `linux`, `linux-lts`, `linux-zen`, `linux-hardened`, `linux-cachyos`
2121 - AMD P-State mode (auto-detected per Zen generation)
2222 - GPU drivers (auto-detected)
2323 - Extra repos (CachyOS, AUR helper)
2424 - Dank Linux desktop on first boot (optional)
2525
26-## Get Started
26+## Quick Start
2727
28-**Requirements:** x86\_64, UEFI, Secure Boot disabled
28+**Requirements:** x86_64, UEFI, Secure Boot disabled
2929
3030 Boot the Arch ISO and run:
3131
@@ -35,31 +35,25 @@ curl -fsSL https://archup.run/install | bash
3535
3636 Reboot when done.
3737
38-## What's Installed
38+## What Gets Installed
3939
40-**Base system:**
41-- Btrfs filesystem, Limine bootloader, Plymouth
42-- Kernel of your choice + matching microcode
43-- GPU drivers and firmware (auto-detected)
44-- NetworkManager, OpenSSH, systemd-resolved, zram
40+**Base packages:** `base`, `linux-firmware`, `btrfs-progs`, `limine`, `efibootmgr`, `plymouth`, `networkmanager`, `openssh`, `firewalld`, `sudo`, `neovim`, `man-db`, `git`, `zram-generator`, Fira Sans, JetBrains Mono Nerd Font
4541
46-**CLI tools:**
47-- Neovim, Git, sudo, man pages
48-- Modern utilities: fzf, ripgrep, bat, eza, zoxide, starship, btop, yazi
49-- Build tools: base-devel, Go, Rust (for AUR)
42+**Extra packages:** `snapper`, `snap-pac`, `base-devel`, Go, Rust/Cargo, GTK3/4/libadwaita, Qt5/6 + Wayland, GStreamer, ffmpeg, Pipewire, Bluetooth (bluez), WiFi (iwd), modern CLI tools (`eza`, `zoxide`, `fzf`, `ripgrep`, `bat`, `fd`, `btop`, `nvtop`, `yazi`, `starship`, `jq`, `git-delta`, `dust`, `duf`, `tealdeer`, `tree`)
5043
51-**First-boot setup (automatic):**
44+**First-boot service (automatic):**
5245 - Snapper configured for Btrfs snapshots
5346 - firewalld enabled
5447 - SSH host keys generated
5548 - ble.sh and shell tooling installed
49+- Optional display manager opt-in
5650
5751 ## Status
5852
59-Active development — tested manually on real hardware.
53+Active development — tested on real hardware.
6054
61-- [x] TUI installer (functional)
62-- [x] LUKS2 encryption support
55+- [x] TUI installer
56+- [x] LUKS2 encryption
6357 - [x] First-boot systemd service
6458 - [ ] Dank Linux desktop (niri/Hyprland) — in progress
6559
@@ -2,30 +2,30 @@
2 <img src="assets/archup-logo-v2-5.png" alt="ArchUp Logo" width="600">2 <img src="assets/archup-logo-v2-5.png" alt="ArchUp Logo" width="600">
3 </p>3 </p>
4 4
5-## What Is ArchUp?5+ArchUp is an opinionated Arch Linux installer that picks the boring defaults so you don't have to.
6 6
7-ArchUp is an Arch Linux installer similar to archinstall but it makes the choices for you on the boring parts. The difference with Omarchy is that it's not enforcing any dotfile or app. The goal is to install Arch as fast as possible with sane defaults.7+## What It Decides
8 8
9-**What it decides for you:**
10 - Btrfs with `@` and `@home` subvolumes9 - Btrfs with `@` and `@home` subvolumes
11 - Limine bootloader (UEFI only)10 - Limine bootloader (UEFI only)
12-- Chaotic-AUR enabled out of the box11+- Chaotic-AUR enabled
13 - Plymouth boot splash12 - Plymouth boot splash
14 - Snapper for snapshot-based rollbacks13 - Snapper for snapshot-based rollbacks
15 - NetworkManager, OpenSSH, zram, firewalld14 - NetworkManager, OpenSSH, zram, firewalld
16 15
17-**What you choose:**16+## What You Choose
17+
18 - Disk and optional LUKS2 encryption18 - Disk and optional LUKS2 encryption
19 - Hostname, user, locale, timezone, keymap19 - Hostname, user, locale, timezone, keymap
20-- Kernel (linux, linux-lts, linux-zen, linux-hardened, linux-cachyos)20+- Kernel: `linux`, `linux-lts`, `linux-zen`, `linux-hardened`, `linux-cachyos`
21 - AMD P-State mode (auto-detected per Zen generation)21 - AMD P-State mode (auto-detected per Zen generation)
22 - GPU drivers (auto-detected)22 - GPU drivers (auto-detected)
23 - Extra repos (CachyOS, AUR helper)23 - Extra repos (CachyOS, AUR helper)
24 - Dank Linux desktop on first boot (optional)24 - Dank Linux desktop on first boot (optional)
25 25
26-## Get Started26+## Quick Start
27 27
28-**Requirements:** x86\_64, UEFI, Secure Boot disabled28+**Requirements:** x86_64, UEFI, Secure Boot disabled
29 29
30 Boot the Arch ISO and run:30 Boot the Arch ISO and run:
31 31
@@ -35,31 +35,25 @@ curl -fsSL https://archup.run/install | bash
35 35
36 Reboot when done.36 Reboot when done.
37 37
38-## What's Installed38+## What Gets Installed
39 39
40-**Base system:**40+**Base packages:** `base`, `linux-firmware`, `btrfs-progs`, `limine`, `efibootmgr`, `plymouth`, `networkmanager`, `openssh`, `firewalld`, `sudo`, `neovim`, `man-db`, `git`, `zram-generator`, Fira Sans, JetBrains Mono Nerd Font
41-- Btrfs filesystem, Limine bootloader, Plymouth
42-- Kernel of your choice + matching microcode
43-- GPU drivers and firmware (auto-detected)
44-- NetworkManager, OpenSSH, systemd-resolved, zram
45 41
46-**CLI tools:**42+**Extra packages:** `snapper`, `snap-pac`, `base-devel`, Go, Rust/Cargo, GTK3/4/libadwaita, Qt5/6 + Wayland, GStreamer, ffmpeg, Pipewire, Bluetooth (bluez), WiFi (iwd), modern CLI tools (`eza`, `zoxide`, `fzf`, `ripgrep`, `bat`, `fd`, `btop`, `nvtop`, `yazi`, `starship`, `jq`, `git-delta`, `dust`, `duf`, `tealdeer`, `tree`)
47-- Neovim, Git, sudo, man pages
48-- Modern utilities: fzf, ripgrep, bat, eza, zoxide, starship, btop, yazi
49-- Build tools: base-devel, Go, Rust (for AUR)
50 43
51-**First-boot setup (automatic):**44+**First-boot service (automatic):**
52 - Snapper configured for Btrfs snapshots45 - Snapper configured for Btrfs snapshots
53 - firewalld enabled46 - firewalld enabled
54 - SSH host keys generated47 - SSH host keys generated
55 - ble.sh and shell tooling installed48 - ble.sh and shell tooling installed
49+- Optional display manager opt-in
56 50
57 ## Status51 ## Status
58 52
59-Active development — tested manually on real hardware.53+Active development — tested on real hardware.
60 54
61-- [x] TUI installer (functional)55+- [x] TUI installer
62-- [x] LUKS2 encryption support56+- [x] LUKS2 encryption
63 - [x] First-boot systemd service57 - [x] First-boot systemd service
64 - [ ] Dank Linux desktop (niri/Hyprland) — in progress58 - [ ] Dank Linux desktop (niri/Hyprland) — in progress
65 59

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 0

    ↑↓ moveenter openesc close