From 100e89b23db2f2bc8b87e1da08bfe8d8262d7f86 Mon Sep 17 00:00:00 2001 From: Bjarke Sporring Date: Fri, 16 Jan 2026 10:26:02 +0100 Subject: [PATCH] refactor: update docs for the install.ps1 script --- install.ps1 | 50 +++++++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/install.ps1 b/install.ps1 index 289f010..391002f 100644 --- a/install.ps1 +++ b/install.ps1 @@ -1,35 +1,39 @@ #!/usr/bin/env pwsh <# -.SYNOPSIS -Installs all prerequisites for Git Workshop using winget and clones the repository. + .SYNOPSIS + Installs all prerequisites for Git Workshop using winget (which is a CLI + tool to the Windows Package Manager Server) and clones the workshop + repository. -.DESCRIPTION -This script automates the installation of required tools for the Git Workshop: -- PowerShell 7 (cross-platform PowerShell) -- Git 2.23+ (version control system) -- Visual Studio Code (code editor with Git integration) + .DESCRIPTION + This script automates the installation of required tools for the Git Workshop: + - PowerShell 7 (cross-platform PowerShell) + - Git 2.23+ (version control system) + - Visual Studio Code (code editor with Git integration) -Optional tools (with user prompts): -- Windows Terminal (modern terminal experience) + Optional tools (with user prompts): + - Windows Terminal (modern terminal experience) -The script checks for existing installations, shows clear progress, and verifies -each installation succeeded. At the end, it clones the repository and can -open it in VSCode for immediate workshop access. + The script checks for existing installations, shows clear progress, and verifies + each installation succeeded. At the end, it clones the repository and can + open it in VSCode for immediate workshop access. -One-shot installation: -Invoke-RestMethod -Uri https://git.frod.dk/floppydiscen/git-workshop/raw/branch/main/install.ps1 | Invoke-Expression + One-shot installation: + Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser + Invoke-RestMethod -Uri https://git.frod.dk/floppydiscen/git-workshop/raw/branch/main/install.ps1 | Invoke-Expression -.EXAMPLE -PS> Invoke-RestMethod -Uri https://git.frod.dk/floppydiscen/git-workshop/raw/branch/main/install.ps1 | Invoke-Expression -Runs the complete installation and setup in one command. + .EXAMPLE + PS> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser + PS> Invoke-RestMethod -Uri https://git.frod.dk/floppydiscen/git-workshop/raw/branch/main/install.ps1 | Invoke-Expression + Runs the complete installation and setup in one command. -.EXAMPLE -PS> .\install.ps1 -Runs the installation script with interactive prompts. + .EXAMPLE + PS> .\install.ps1 + Runs the installation script with interactive prompts. -.NOTES -Requires Windows 11 with winget (App Installer) available. -Some installations may require administrator privileges. + .NOTES + Requires Windows 11 with winget (App Installer) available. + Some installations may require administrator privileges. #> [CmdletBinding()]