diff --git a/README.md b/README.md index c33eebb..1fce32f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ # steam-frame-nix [Home Manager](https://github.com/nix-community/home-manager) modules for the -Valve Steam Frame: SteamOS on `aarch64-linux`, standalone home-manager on a -non-NixOS system. They work around quirks of the Frame's two graphical -sessions (portal config, keyboard layout, clipboard, Firefox) and extend -Steam's and SteamVR's UIs at runtime (VR keyboard, "+" menu, dashboard -window limits, a close button for Steam's VR window, window curvature, -window controls) declaratively, so every change can be reverted by -activating an older home-manager generation. +Valve Steam Frame (SteamOS, `aarch64-linux`, standalone home-manager). They +work around quirks of the Frame's two graphical sessions (portal, keyboard +layout, clipboard, Firefox) and extend Steam's and SteamVR's UIs at runtime +(VR keyboard, "+" menu, dashboard windows, Steam close button, window +curvature, window controls). Everything is declarative and reverts by +activating an older generation. All options live under `steamFrame.*`. The portal fix and clipboard sync are on by default; everything else is opt-in. @@ -35,60 +34,47 @@ on by default; everything else is opt-in. ## Install -On the Frame (or a Steam Deck), open a terminal (Konsole in the desktop -mode / nested desktop) and run: +On the Frame (or a Steam Deck), in a terminal (Konsole in desktop mode or the +nested desktop): ```sh curl -fsSL https://steam-frame-nix.lhns.de | bash -s -- install ``` -`https://steam-frame-nix.lhns.de` redirects to +The short link redirects to [`install.sh`](https://raw.githubusercontent.com/lhns/steam-frame-nix/main/install.sh) -on the `main` branch; use that URL directly if the short link is unreachable. +on `main`. `sudo` needs a password: run `passwd` first if you never set one. -`sudo` needs a password: if you never set one, run `passwd` first. +The installer: -What it does: +1. installs Nix with the [NixOS nix-installer](https://github.com/NixOS/nix-installer) + (`steam-deck` planner: store in `/home/nix`, survives SteamOS updates; + flakes on), unlocking the read-only root only for the install. Skipped if + Nix already works; +2. uses `~/.config/home-manager` or `--flake `; if there is + none, creates `~/nix-config` (a git repo, linked to + `~/.config/home-manager`) from the template with your user name; +3. runs `home-manager switch`; conflicting dotfiles are renamed to + `*.hm-backup-