diff --git a/README.md b/README.md index 3bab0c4..366f2b4 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,11 @@ Install the software and settings for a Windows desktop, then keep its configs up to date with one command. No management server or background agent is needed. -## 1. Set up the computer once +Both commands below apply the latest repository configs. **Install** also sets +up the tools and installs or updates the declared software. **Update** does only +the configs, making it the faster choice for everyday changes after setup. + +## 1. Install software and apply configs Open **Windows PowerShell** as your normal desktop user and paste: @@ -15,12 +19,13 @@ The bundled machine profile is `beffroi-laptop`, selected automatically. If you add more machines, setup matches the computer name or asks you to choose one. It installs Git, PowerShell 7, and the declared software, then applies the configs. Approve administrator prompts when needed. Existing managed settings are backed up and -replaced with repository versions. Rerun this command to repair setup. +replaced with repository versions. Run this command on a new computer, when you +add software to the install list, or when you need to repair setup. Requires Windows 10 1809 or newer, Windows 11, or Windows Server 2025, with internet access and support for WinGet. -## 2. Update configs whenever needed +## 2. Use update for routine config changes Close the applications whose settings you are updating, then paste into **PowerShell**: @@ -30,8 +35,10 @@ irm 'https://proxy.dandaedre.com/gitea/Beffroi/config-central/raw/branch/main/up ``` This downloads the latest configs and updater code from your saved repository -branch and applies them to your saved machine profile. No menu, manual Git pull, -or software installation. Temporary downloads are removed afterward. +branch and applies them to your saved machine profile, using the same config +deployment as install. It skips prerequisite setup and software installation or +upgrades. No menu or manual Git pull is needed; temporary downloads are removed +afterward. Run install once before using update on a new computer. Unchanged configs are skipped. Local settings are backed up and replaced with the repository versions by default. To preserve local edits instead, see diff --git a/TASKS.md b/TASKS.md index 7076914..eb02689 100644 --- a/TASKS.md +++ b/TASKS.md @@ -148,3 +148,4 @@ open until it is run on disposable machines with the required account setups. - [x] Add capture/apply adapters for Windows sound-event assignments and the active plan's battery display timeout, with constrained declarations, backups, drift detection, and rollback; validate with Linux mocks. - [x] Enable the Windows sound/power defaults in desktop profiles and document the capture/update workflow. +- [x] Clarify when to use install versus the faster config-only update in the README.