julianprester/linux-provisioning
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README: add one-liner quick start; remove stale zshrc.local.example refs

Browse Source
This commit is contained in:
Julian Prester
2026-06-07 15:32:29 +10:00
parent a249dec1ba
commit 5e75868df7
1 changed files with 10 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -18,23 +18,15 @@ Detection is in `lib/distro.sh`. It sets variables like `$PKG_INSTALL`,
## Quick Start ## Quick Start
```bash ```bash
# Clone this repo on the new machine git clone https://github.com/julianprester/linux-provision.git ~/linux-provision && bash ~/linux-provision/provision.sh --all
git clone git@github.com:julianprester/linux-provision.git ~/linux-provision ```
cd ~/linux-provision
# Review and edit config/shell/zshrc.local with your API keys Or run individual stages:
cp config/shell/zshrc.local.example ~/.zshrc.local
# Edit ~/.zshrc.local with real API keys
# Run the full provisioning (will prompt for sudo) ```bash
bash provision.sh --all bash ~/linux-provision/provision.sh --stage 03-toolchains
bash ~/linux-provision/provision.sh --list
# Or run individual stages source ~/linux-provision/provision.sh --interactive
bash provision.sh --stage 03-toolchains
bash provision.sh --stage 06-uv-projects
# Or source it for interactive use
source provision.sh --interactive
``` ```
## Structure ## Structure
@@ -59,7 +51,7 @@ linux-provision/
│ └── 12-other-apps.sh # Chrome, Signal, Zotero │ └── 12-other-apps.sh # Chrome, Signal, Zotero
├── config/ # Dotfiles and config files (installed by stages) ├── config/ # Dotfiles and config files (installed by stages)
│ ├── git/gitconfig │ ├── 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} │ ├── scripts/{bw-load-ssh.sh,idle-battery-suspend.sh,zoom.sh,env.sh}
│ ├── systemd/{porridge.service,...} │ ├── systemd/{porridge.service,...}
│ ├── sysctl/99-custom.conf │ ├── sysctl/99-custom.conf
@@ -98,8 +90,8 @@ from Bitwarden, configuring Tailscale, importing GPG keys, etc.
names adapt automatically. names adapt automatically.
- **Idempotent** — safe to run multiple times. Stages check for existing - **Idempotent** — safe to run multiple times. Stages check for existing
installations before repeating work. installations before repeating work.
- **Secrets out of repo** — API keys live in `~/.zshrc.local` (gitignored). - **Secrets out of repo** — API keys live in `~/.zshrc.local` (gitignored)
The repo ships `zshrc.local.example` with placeholder values. and are loaded at shell startup from Bitwarden via `bw` + `jq`.
- **One stage per concern** — comment out stages you don't need in - **One stage per concern** — comment out stages you don't need in
`provision.sh` or pass `--stage` individually. `provision.sh` or pass `--stage` individually.
- **Hardware-specific quirks commented out** — AMD GPU kernel params, - **Hardware-specific quirks commented out** — AMD GPU kernel params,