docs(readme): simplify and restructure installation documentation
- commit
- 65d1092eb8244de1d854f04f3b2441d18e9c2956
- author
- bnema · · 2025-10-29 17:38 UTC
- parent
- 68831a0
- signature
- GPG Unverified
2B82207D370127A0The key is unknown
1 file · +45 -59
M README.md +45 -59
| @@ -4,83 +4,69 @@ | |||
| 4 | 4 | ||
| 5 | 5 | ## What Is ArchUp? | |
| 6 | 6 | ||
| 7 | - | ArchUp is a minimal, slightly opinionated Arch Linux installer focused on Wayland window managers. It provides a barebone base system with sane defaults and an optional CLI to build your ideal desktop environment. | |
| 7 | + | ArchUp is a minimal Arch Linux installer for Wayland. Boot the ISO, run it, and you get a working barebone system. Hardware is detected automatically and defaults are sensible. Afterward, you can optionally add a desktop environment. | |
| 8 | 8 | ||
| 9 | - | - **Barebone first** - Install just the essentials and stop here if you want | |
| 10 | - | - **User choice** - Every layer is optional; you decide what to install from a supported list of apps | |
| 11 | - | - **Lightweight focused** - Only Wayland compositors (Niri, Hyprland, Sway, River) | |
| 12 | - | - **Smart foundation** - Critical desktop infrastructure pre-configured (graphics, audio, Wayland, BT, printing) | |
| 13 | - | - **Hardware detection** - Auto-detects GPU and installs correct drivers | |
| 14 | - | - **Coherent UI** - One dark/light theme across all apps (customizable later) | |
| 15 | - | - **Just works** - All infrastructure configured; focus on your workflow, not setup | |
| 9 | + | **Includes:** | |
| 10 | + | - Lean system without unnecessary packages | |
| 11 | + | - Ready-to-use shell environment with modern CLI tools configured and themed | |
| 12 | + | - CPU optimization (amd_pstate/cpu governor) and automatic GPU driver detection | |
| 13 | + | - Essential libraries and packages (Qt5, GTK4, etc.) for a functional environment | |
| 14 | + | - Coherent theme applied across all supported applications | |
| 15 | + | - Full customization after installation | |
| 16 | 16 | ||
| 17 | - | ## What ArchUp Is NOT | |
| 17 | + | **Does not include:** | |
| 18 | + | - KDE, GNOME, or other full desktop environments | |
| 19 | + | - Any attempt to be a standalone distro | |
| 20 | + | - Locked-in configurations | |
| 21 | + | - Bloated softwares | |
| 18 | 22 | ||
| 19 | - | - **Not a desktop environment** - We won't support KDE, GNOME, or other full-fledged DEs | |
| 20 | - | - **Not a distro** - It's an installer, not a custom Arch spin | |
| 21 | - | - **Not bloated** - We provide the minimum to get you started | |
| 22 | - | - **Not an Omarchy copy** - We respect Omarchy's architecture but keep it minimal | |
| 23 | + | ## Get Started | |
| 23 | 24 | ||
| 24 | - | ## Philosophy | |
| 25 | + | **Need:** AMD/Intel 64-bit system, UEFI | |
| 25 | 26 | ||
| 26 | - | ArchUp put the user in control. Every layer is optional: | |
| 27 | - | ||
| 28 | - | - Want barebone CLI but with a cool bootloader? Stop at Tier 1 | |
| 29 | - | - Need a lightweight GUI? Add Tier 2+3 | |
| 30 | - | - Want to customize? Manual changes are easy; we don't lock you in | |
| 31 | - | ||
| 32 | - | We learned from Omarchy's excellent modular approach but rejected the bloat. ArchUp provides smart defaults (proven to work) while staying minimal and respecting user choice. | |
| 33 | - | ||
| 34 | - | ## Quick Start | |
| 35 | - | ||
| 36 | - | **Requirements**: AMD/Intel 64-bit system, UEFI mode | |
| 37 | - | ||
| 38 | - | ### Go-based Installer (Recommended) | |
| 39 | - | ||
| 40 | - | Interactive TUI with configuration preview and better error handling: | |
| 27 | + | Boot the Arch ISO and run: | |
| 41 | 28 | ||
| 42 | 29 | ```bash | |
| 43 | - | # 1. Boot Arch ISO, run installer | |
| 44 | - | curl -fsSL https://archup.run/install/bin | bash | |
| 45 | - | ||
| 46 | - | # Install dev/pre-release version | |
| 47 | - | curl -fsSL https://archup.run/install/bin | bash -s -- --dev | |
| 48 | - | ||
| 49 | - | # 2. Reboot into new system | |
| 50 | - | ||
| 51 | - | # 3. Run wizard to add desktop (optional) | |
| 52 | - | archup wizard | |
| 30 | + | curl -fsSL https://archup.run/install | bash | |
| 53 | 31 | ``` | |
| 54 | 32 | ||
| 55 | - | ### Legacy Bash Installer | |
| 56 | - | ||
| 57 | - | Simple script-based installer: | |
| 33 | + | Reboot when done. | |
| 58 | 34 | ||
| 35 | + | For development versions: | |
| 59 | 36 | ```bash | |
| 60 | - | # 1. Boot Arch ISO, install barebone system | |
| 61 | - | curl -fsSL https://archup.run/install | sh | |
| 37 | + | curl -fsSL https://archup.run/install/dev | bash | |
| 38 | + | ``` | |
| 62 | 39 | ||
| 63 | - | # 2. Reboot into new system | |
| 40 | + | ## What's Installed | |
| 64 | 41 | ||
| 65 | - | # 3. Run wizard to add desktop (optional) | |
| 66 | - | archup wizard | |
| 67 | - | ``` | |
| 42 | + | **Core system:** | |
| 43 | + | - btrfs filesystem, Limine bootloader, Plymouth | |
| 44 | + | - Kernel selection: linux, linux-lts, or linux-zen | |
| 45 | + | - GPU drivers and firmware (auto-detected) | |
| 46 | + | - NetworkManager, OpenSSH, systemd-resolved | |
| 68 | 47 | ||
| 69 | - | ## Status | |
| 48 | + | **CLI tools:** | |
| 49 | + | - Neovim, Git, sudo, man pages | |
| 50 | + | - Modern utilities: fzf, ripgrep, bat, eza, zoxide, starship, btop, yazi | |
| 51 | + | - Build tools: gcc, make, Go, Rust (for AUR packages) | |
| 70 | 52 | ||
| 71 | - | The barebone installer is ready for testing, I am currently actively working on the CLI wizard for desktop setup. | |
| 53 | + | **System utilities:** | |
| 54 | + | - Snapper for snapshots and rollbacks | |
| 55 | + | - Bluetooth and audio configuration | |
| 56 | + | - Firewall (ufw) and power management (TLP) | |
| 57 | + | - Shell completion and theme system | |
| 72 | 58 | ||
| 73 | - | - [x] Tier 1: Barebone CLI installer | |
| 74 | - | - [x] Auto-builds `archup` CLI on first boot | |
| 75 | - | - [ ] Tier 2+3: Desktop wizard (in `archup-cli` repo) | |
| 59 | + | Run `archup wizard` after installation to add a Wayland compositor (Hyprland, Sway, Niri, or River) with integrated theming. Support will expand as the community contributes. | |
| 76 | 60 | ||
| 77 | - | **⚠️ Alpha/Testing Phase**: ArchUp is in active development. All contributions, bug reports, and error logs are welcome! Please open an issue if you encounter any problems. | |
| 61 | + | ## Status | |
| 78 | 62 | ||
| 79 | - | ## Links | |
| 63 | + | - [x] Barebone installer (functional, testing in progress) | |
| 64 | + | - [x] CLI auto-builds on first boot | |
| 65 | + | - [ ] Desktop wizard (in progress in [archup-cli](https://github.com/bnema/archup-cli)) | |
| 80 | 66 | ||
| 81 | - | - **CLI repo**: [github.com/bnema/archup-cli](https://github.com/bnema/archup-cli) | |
| 67 | + | Active development. Report bugs with logs. | |
| 82 | 68 | ||
| 83 | - | ## Thanks | |
| 69 | + | ## Acknowledgments | |
| 84 | 70 | ||
| 85 | - | - **[Omarchy](https://github.com/omakub/omakub)** - For the excellent modular architecture inspiration (MIT License) | |
| 86 | - | - **[Charmbracelet Gum](https://github.com/charmbracelet/gum)** - For the awesome interactive shell toolkit | |
| 71 | + | - [Omarchy](https://github.com/omakub/omakub) - modular architecture approach | |
| 72 | + | - [Charmbracelet Gum](https://github.com/charmbracelet/gum) - interactive UI toolkit | |
| @@ -4,83 +4,69 @@ | |||||
| 4 | 4 | ||||
| 5 | ## What Is ArchUp? | 5 | ## What Is ArchUp? | ||
| 6 | 6 | ||||
| 7 | - | ArchUp is a minimal, slightly opinionated Arch Linux installer focused on Wayland window managers. It provides a barebone base system with sane defaults and an optional CLI to build your ideal desktop environment. | 7 | + | ArchUp is a minimal Arch Linux installer for Wayland. Boot the ISO, run it, and you get a working barebone system. Hardware is detected automatically and defaults are sensible. Afterward, you can optionally add a desktop environment. |
| 8 | 8 | ||||
| 9 | - | - **Barebone first** - Install just the essentials and stop here if you want | 9 | + | **Includes:** |
| 10 | - | - **User choice** - Every layer is optional; you decide what to install from a supported list of apps | 10 | + | - Lean system without unnecessary packages |
| 11 | - | - **Lightweight focused** - Only Wayland compositors (Niri, Hyprland, Sway, River) | 11 | + | - Ready-to-use shell environment with modern CLI tools configured and themed |
| 12 | - | - **Smart foundation** - Critical desktop infrastructure pre-configured (graphics, audio, Wayland, BT, printing) | 12 | + | - CPU optimization (amd_pstate/cpu governor) and automatic GPU driver detection |
| 13 | - | - **Hardware detection** - Auto-detects GPU and installs correct drivers | 13 | + | - Essential libraries and packages (Qt5, GTK4, etc.) for a functional environment |
| 14 | - | - **Coherent UI** - One dark/light theme across all apps (customizable later) | 14 | + | - Coherent theme applied across all supported applications |
| 15 | - | - **Just works** - All infrastructure configured; focus on your workflow, not setup | 15 | + | - Full customization after installation |
| 16 | 16 | ||||
| 17 | - | ## What ArchUp Is NOT | 17 | + | **Does not include:** |
| 18 | + | - KDE, GNOME, or other full desktop environments | |||
| 19 | + | - Any attempt to be a standalone distro | |||
| 20 | + | - Locked-in configurations | |||
| 21 | + | - Bloated softwares | |||
| 18 | 22 | ||||
| 19 | - | - **Not a desktop environment** - We won't support KDE, GNOME, or other full-fledged DEs | 23 | + | ## Get Started |
| 20 | - | - **Not a distro** - It's an installer, not a custom Arch spin | |||
| 21 | - | - **Not bloated** - We provide the minimum to get you started | |||
| 22 | - | - **Not an Omarchy copy** - We respect Omarchy's architecture but keep it minimal | |||
| 23 | 24 | ||||
| 24 | - | ## Philosophy | 25 | + | **Need:** AMD/Intel 64-bit system, UEFI |
| 25 | 26 | ||||
| 26 | - | ArchUp put the user in control. Every layer is optional: | 27 | + | Boot the Arch ISO and run: |
| 27 | - | ||||
| 28 | - | - Want barebone CLI but with a cool bootloader? Stop at Tier 1 | |||
| 29 | - | - Need a lightweight GUI? Add Tier 2+3 | |||
| 30 | - | - Want to customize? Manual changes are easy; we don't lock you in | |||
| 31 | - | ||||
| 32 | - | We learned from Omarchy's excellent modular approach but rejected the bloat. ArchUp provides smart defaults (proven to work) while staying minimal and respecting user choice. | |||
| 33 | - | ||||
| 34 | - | ## Quick Start | |||
| 35 | - | ||||
| 36 | - | **Requirements**: AMD/Intel 64-bit system, UEFI mode | |||
| 37 | - | ||||
| 38 | - | ### Go-based Installer (Recommended) | |||
| 39 | - | ||||
| 40 | - | Interactive TUI with configuration preview and better error handling: | |||
| 41 | 28 | ||||
| 42 | ```bash | 29 | ```bash | ||
| 43 | - | # 1. Boot Arch ISO, run installer | 30 | + | curl -fsSL https://archup.run/install | bash |
| 44 | - | curl -fsSL https://archup.run/install/bin | bash | |||
| 45 | - | ||||
| 46 | - | # Install dev/pre-release version | |||
| 47 | - | curl -fsSL https://archup.run/install/bin | bash -s -- --dev | |||
| 48 | - | ||||
| 49 | - | # 2. Reboot into new system | |||
| 50 | - | ||||
| 51 | - | # 3. Run wizard to add desktop (optional) | |||
| 52 | - | archup wizard | |||
| 53 | ``` | 31 | ``` | ||
| 54 | 32 | ||||
| 55 | - | ### Legacy Bash Installer | 33 | + | Reboot when done. |
| 56 | - | ||||
| 57 | - | Simple script-based installer: | |||
| 58 | 34 | ||||
| 35 | + | For development versions: | |||
| 59 | ```bash | 36 | ```bash | ||
| 60 | - | # 1. Boot Arch ISO, install barebone system | 37 | + | curl -fsSL https://archup.run/install/dev | bash |
| 61 | - | curl -fsSL https://archup.run/install | sh | 38 | + | ``` |
| 62 | 39 | ||||
| 63 | - | # 2. Reboot into new system | 40 | + | ## What's Installed |
| 64 | 41 | ||||
| 65 | - | # 3. Run wizard to add desktop (optional) | 42 | + | **Core system:** |
| 66 | - | archup wizard | 43 | + | - btrfs filesystem, Limine bootloader, Plymouth |
| 67 | - | ``` | 44 | + | - Kernel selection: linux, linux-lts, or linux-zen |
| 45 | + | - GPU drivers and firmware (auto-detected) | |||
| 46 | + | - NetworkManager, OpenSSH, systemd-resolved | |||
| 68 | 47 | ||||
| 69 | - | ## Status | 48 | + | **CLI tools:** |
| 49 | + | - Neovim, Git, sudo, man pages | |||
| 50 | + | - Modern utilities: fzf, ripgrep, bat, eza, zoxide, starship, btop, yazi | |||
| 51 | + | - Build tools: gcc, make, Go, Rust (for AUR packages) | |||
| 70 | 52 | ||||
| 71 | - | The barebone installer is ready for testing, I am currently actively working on the CLI wizard for desktop setup. | 53 | + | **System utilities:** |
| 54 | + | - Snapper for snapshots and rollbacks | |||
| 55 | + | - Bluetooth and audio configuration | |||
| 56 | + | - Firewall (ufw) and power management (TLP) | |||
| 57 | + | - Shell completion and theme system | |||
| 72 | 58 | ||||
| 73 | - | - [x] Tier 1: Barebone CLI installer | 59 | + | Run `archup wizard` after installation to add a Wayland compositor (Hyprland, Sway, Niri, or River) with integrated theming. Support will expand as the community contributes. |
| 74 | - | - [x] Auto-builds `archup` CLI on first boot | |||
| 75 | - | - [ ] Tier 2+3: Desktop wizard (in `archup-cli` repo) | |||
| 76 | 60 | ||||
| 77 | - | **⚠️ Alpha/Testing Phase**: ArchUp is in active development. All contributions, bug reports, and error logs are welcome! Please open an issue if you encounter any problems. | 61 | + | ## Status |
| 78 | 62 | ||||
| 79 | - | ## Links | 63 | + | - [x] Barebone installer (functional, testing in progress) |
| 64 | + | - [x] CLI auto-builds on first boot | |||
| 65 | + | - [ ] Desktop wizard (in progress in [archup-cli](https://github.com/bnema/archup-cli)) | |||
| 80 | 66 | ||||
| 81 | - | - **CLI repo**: [github.com/bnema/archup-cli](https://github.com/bnema/archup-cli) | 67 | + | Active development. Report bugs with logs. |
| 82 | 68 | ||||
| 83 | - | ## Thanks | 69 | + | ## Acknowledgments |
| 84 | 70 | ||||
| 85 | - | - **[Omarchy](https://github.com/omakub/omakub)** - For the excellent modular architecture inspiration (MIT License) | 71 | + | - [Omarchy](https://github.com/omakub/omakub) - modular architecture approach |
| 86 | - | - **[Charmbracelet Gum](https://github.com/charmbracelet/gum)** - For the awesome interactive shell toolkit | 72 | + | - [Charmbracelet Gum](https://github.com/charmbracelet/gum) - interactive UI toolkit |