detached d29f303

docs(readme): add system requirements, alpha warning, and acknowledgments

commit
d29f303f5d3cb26ff36778aa2d338529f8899676
author
bnema · · 2025-10-21 06:33 UTC
parent
23a0aa8
signature
unsigned
1 file · +9 -0
M README.md +9 -0
@@ -31,6 +31,8 @@ We learned from Omarchy's excellent modular approach but rejected the bloat. Arc
3131
3232 ## Quick Start
3333
34+**Requirements**: AMD/Intel 64-bit system
35+
3436 ```bash
3537 # 1. Boot Arch ISO, install barebone system
3638 curl -fsSL https://archup.bnema.dev/install | bash
@@ -49,8 +51,15 @@ archup wizard
4951 - [x] Auto-builds `archup` CLI on first boot
5052 - [ ] Tier 2+3: Desktop wizard (in `archup-cli` repo)
5153
54+**⚠️ 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.
55+
5256 ## Links
5357
5458 - **Install**: `https://archup.bnema.dev/install`
5559 - **Dev branch**: `https://archup.bnema.dev/install/dev`
5660 - **CLI repo**: `github.com/bnema/archup-cli`
61+
62+## Thanks
63+
64+- **[Omarchy](https://github.com/omakub/omakub)** - For the excellent modular architecture inspiration (MIT License)
65+- **[Charmbracelet Gum](https://github.com/charmbracelet/gum)** - For the awesome interactive shell toolkit
@@ -31,6 +31,8 @@ We learned from Omarchy's excellent modular approach but rejected the bloat. Arc
31 31
32 ## Quick Start32 ## Quick Start
33 33
34+**Requirements**: AMD/Intel 64-bit system
35+
34 ```bash36 ```bash
35 # 1. Boot Arch ISO, install barebone system37 # 1. Boot Arch ISO, install barebone system
36 curl -fsSL https://archup.bnema.dev/install | bash38 curl -fsSL https://archup.bnema.dev/install | bash
@@ -49,8 +51,15 @@ archup wizard
49 - [x] Auto-builds `archup` CLI on first boot51 - [x] Auto-builds `archup` CLI on first boot
50 - [ ] Tier 2+3: Desktop wizard (in `archup-cli` repo)52 - [ ] Tier 2+3: Desktop wizard (in `archup-cli` repo)
51 53
54+**⚠️ 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.
55+
52 ## Links56 ## Links
53 57
54 - **Install**: `https://archup.bnema.dev/install`58 - **Install**: `https://archup.bnema.dev/install`
55 - **Dev branch**: `https://archup.bnema.dev/install/dev`59 - **Dev branch**: `https://archup.bnema.dev/install/dev`
56 - **CLI repo**: `github.com/bnema/archup-cli`60 - **CLI repo**: `github.com/bnema/archup-cli`
61+
62+## Thanks
63+
64+- **[Omarchy](https://github.com/omakub/omakub)** - For the excellent modular architecture inspiration (MIT License)
65+- **[Charmbracelet Gum](https://github.com/charmbracelet/gum)** - For the awesome interactive shell toolkit

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