refactor: update docs for the install.ps1 script
This commit is contained in:
50
install.ps1
50
install.ps1
@@ -1,35 +1,39 @@
|
|||||||
#!/usr/bin/env pwsh
|
#!/usr/bin/env pwsh
|
||||||
<#
|
<#
|
||||||
.SYNOPSIS
|
.SYNOPSIS
|
||||||
Installs all prerequisites for Git Workshop using winget and clones the repository.
|
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
|
.DESCRIPTION
|
||||||
This script automates the installation of required tools for the Git Workshop:
|
This script automates the installation of required tools for the Git Workshop:
|
||||||
- PowerShell 7 (cross-platform PowerShell)
|
- PowerShell 7 (cross-platform PowerShell)
|
||||||
- Git 2.23+ (version control system)
|
- Git 2.23+ (version control system)
|
||||||
- Visual Studio Code (code editor with Git integration)
|
- Visual Studio Code (code editor with Git integration)
|
||||||
|
|
||||||
Optional tools (with user prompts):
|
Optional tools (with user prompts):
|
||||||
- Windows Terminal (modern terminal experience)
|
- Windows Terminal (modern terminal experience)
|
||||||
|
|
||||||
The script checks for existing installations, shows clear progress, and verifies
|
The script checks for existing installations, shows clear progress, and verifies
|
||||||
each installation succeeded. At the end, it clones the repository and can
|
each installation succeeded. At the end, it clones the repository and can
|
||||||
open it in VSCode for immediate workshop access.
|
open it in VSCode for immediate workshop access.
|
||||||
|
|
||||||
One-shot installation:
|
One-shot installation:
|
||||||
Invoke-RestMethod -Uri https://git.frod.dk/floppydiscen/git-workshop/raw/branch/main/install.ps1 | Invoke-Expression
|
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
|
||||||
|
Invoke-RestMethod -Uri https://git.frod.dk/floppydiscen/git-workshop/raw/branch/main/install.ps1 | Invoke-Expression
|
||||||
|
|
||||||
.EXAMPLE
|
.EXAMPLE
|
||||||
PS> Invoke-RestMethod -Uri https://git.frod.dk/floppydiscen/git-workshop/raw/branch/main/install.ps1 | Invoke-Expression
|
PS> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
|
||||||
Runs the complete installation and setup in one command.
|
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
|
.EXAMPLE
|
||||||
PS> .\install.ps1
|
PS> .\install.ps1
|
||||||
Runs the installation script with interactive prompts.
|
Runs the installation script with interactive prompts.
|
||||||
|
|
||||||
.NOTES
|
.NOTES
|
||||||
Requires Windows 11 with winget (App Installer) available.
|
Requires Windows 11 with winget (App Installer) available.
|
||||||
Some installations may require administrator privileges.
|
Some installations may require administrator privileges.
|
||||||
#>
|
#>
|
||||||
|
|
||||||
[CmdletBinding()]
|
[CmdletBinding()]
|
||||||
|
|||||||
Reference in New Issue
Block a user