From 72fd0c5f8377e8cbeffc7d2c216c011bb426d73e Mon Sep 17 00:00:00 2001 From: Chawye Hsu Date: Wed, 23 Mar 2022 13:59:16 +0800 Subject: [PATCH] docs(readme): Update installation instruction (#4825) --- CHANGELOG.md | 1 + README.md | 49 ++----------------------------------------------- 2 files changed, 3 insertions(+), 47 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 79d65c2bcb..b281447b83 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ ### Documentation +- **readme:** Update installation instruction ([#4825](https://github.com/ScoopInstaller/Scoop/issues/4825)) - **readme:** Fix badges for Gitter and CI Tests ([#4830](https://github.com/ScoopInstaller/Scoop/issues/4830)) - **scoop-shim:**: Fix typo ([#4836](https://github.com/ScoopInstaller/Scoop/issues/4836)) diff --git a/README.md b/README.md index 5b29b5768a..706e5a7bf3 100644 --- a/README.md +++ b/README.md @@ -56,60 +56,15 @@ scoop install python ruby go perl If you've built software that you'd like others to use, Scoop is an alternative to building an installer (e.g. MSI or InnoSetup) — you just need to zip your program and provide a JSON manifest that describes how to install it. -## Requirements - -- Windows 7 SP1+ / Windows Server 2008+ -- [PowerShell 5](https://aka.ms/wmf5download) (or later, include [PowerShell Core](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-windows?view=powershell-6)) and [.NET Framework 4.5](https://www.microsoft.com/net/download) (or later) -- PowerShell must be enabled for your user account e.g. `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser` - ## Installation -Run the following command from your PowerShell to install scoop to its default location (`C:\Users\\scoop`) +Run the following command from a **non-admin** PowerShell to install scoop to its default location `C:\Users\\scoop`. ```powershell -Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://get.scoop.sh') - -# or shorter iwr -useb get.scoop.sh | iex ``` -Once installed, run `scoop help` for instructions. - -The default setup is configured so all user installed programs and Scoop itself live in `C:\Users\\scoop`. -Globally installed programs (`--global`) live in `C:\ProgramData\scoop`. -These settings can be changed through environment variables. - -### Install Scoop to a Custom Directory by changing `SCOOP` - -```powershell -$env:SCOOP='D:\Applications\Scoop' -[Environment]::SetEnvironmentVariable('SCOOP', $env:SCOOP, 'User') -# run the installer -``` - -### Configure Scoop to install global programs to a Custom Directory by changing `SCOOP_GLOBAL` - -```powershell -$env:SCOOP_GLOBAL='F:\GlobalScoopApps' -[Environment]::SetEnvironmentVariable('SCOOP_GLOBAL', $env:SCOOP_GLOBAL, 'Machine') -# run the installer -``` - -### Configure Scoop to store downloads to a Custom Directory by changing `SCOOP_CACHE` - -```powershell -$env:SCOOP_CACHE='F:\ScoopCache' -[Environment]::SetEnvironmentVariable('SCOOP_CACHE', $env:SCOOP_CACHE, 'Machine') -# run the installer -``` - -### Configure Scoop to use a GitHub API token during searching and checkver by setting `SCOOP_GH_TOKEN` - -```powershell -$env:SCOOP_GH_TOKEN='' -[Environment]::SetEnvironmentVariable('SCOOP_GH_TOKEN', $env:SCOOP_GH_TOKEN, 'Machine') -# search for an app -``` +Advanced installation instruction and full documentation of the installer are available in [ScoopInstaller/Install](https://github.com/ScoopInstaller/Install). Please create new issues there if you have questions about the installation. ## [Documentation](https://github.com/ScoopInstaller/Scoop/wiki)