From 5e75868df74e9a0e7a862ea5a048848e7c90b521 Mon Sep 17 00:00:00 2001 From: Julian Prester Date: Sun, 7 Jun 2026 15:32:29 +1000 Subject: [PATCH] README: add one-liner quick start; remove stale zshrc.local.example refs --- README.md | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index b830f3f..2b5b2f3 100755 --- a/README.md +++ b/README.md @@ -18,23 +18,15 @@ Detection is in `lib/distro.sh`. It sets variables like `$PKG_INSTALL`, ## Quick Start ```bash -# Clone this repo on the new machine -git clone git@github.com:julianprester/linux-provision.git ~/linux-provision -cd ~/linux-provision +git clone https://github.com/julianprester/linux-provision.git ~/linux-provision && bash ~/linux-provision/provision.sh --all +``` -# Review and edit config/shell/zshrc.local with your API keys -cp config/shell/zshrc.local.example ~/.zshrc.local -# Edit ~/.zshrc.local with real API keys +Or run individual stages: -# Run the full provisioning (will prompt for sudo) -bash provision.sh --all - -# Or run individual stages -bash provision.sh --stage 03-toolchains -bash provision.sh --stage 06-uv-projects - -# Or source it for interactive use -source provision.sh --interactive +```bash +bash ~/linux-provision/provision.sh --stage 03-toolchains +bash ~/linux-provision/provision.sh --list +source ~/linux-provision/provision.sh --interactive ``` ## Structure @@ -59,7 +51,7 @@ linux-provision/ │ └── 12-other-apps.sh # Chrome, Signal, Zotero ├── config/ # Dotfiles and config files (installed by stages) │ ├── git/gitconfig -│ ├── shell/{zshrc,zshrc.local.example,p10k.zsh} +│ ├── shell/{zshrc,p10k.zsh} │ ├── scripts/{bw-load-ssh.sh,idle-battery-suspend.sh,zoom.sh,env.sh} │ ├── systemd/{porridge.service,...} │ ├── sysctl/99-custom.conf @@ -98,8 +90,8 @@ from Bitwarden, configuring Tailscale, importing GPG keys, etc. names adapt automatically. - **Idempotent** — safe to run multiple times. Stages check for existing installations before repeating work. -- **Secrets out of repo** — API keys live in `~/.zshrc.local` (gitignored). - The repo ships `zshrc.local.example` with placeholder values. +- **Secrets out of repo** — API keys live in `~/.zshrc.local` (gitignored) + and are loaded at shell startup from Bitwarden via `bw` + `jq`. - **One stage per concern** — comment out stages you don't need in `provision.sh` or pass `--stage` individually. - **Hardware-specific quirks commented out** — AMD GPU kernel params,