Skip to content

Commit 72fd0c5

Browse files
authored
docs(readme): Update installation instruction (#4825)
1 parent d29e336 commit 72fd0c5

2 files changed

Lines changed: 3 additions & 47 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323

2424
### Documentation
2525

26+
- **readme:** Update installation instruction ([#4825](https://github.com/ScoopInstaller/Scoop/issues/4825))
2627
- **readme:** Fix badges for Gitter and CI Tests ([#4830](https://github.com/ScoopInstaller/Scoop/issues/4830))
2728
- **scoop-shim:**: Fix typo ([#4836](https://github.com/ScoopInstaller/Scoop/issues/4836))
2829

README.md

Lines changed: 2 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -56,60 +56,15 @@ scoop install python ruby go perl
5656

5757
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.
5858

59-
## Requirements
60-
61-
- Windows 7 SP1+ / Windows Server 2008+
62-
- [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)
63-
- PowerShell must be enabled for your user account e.g. `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`
64-
6559
## Installation
6660

67-
Run the following command from your PowerShell to install scoop to its default location (`C:\Users\<user>\scoop`)
61+
Run the following command from a **non-admin** PowerShell to install scoop to its default location `C:\Users\<YOUR USERNAME>\scoop`.
6862

6963
```powershell
70-
Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://get.scoop.sh')
71-
72-
# or shorter
7364
iwr -useb get.scoop.sh | iex
7465
```
7566

76-
Once installed, run `scoop help` for instructions.
77-
78-
The default setup is configured so all user installed programs and Scoop itself live in `C:\Users\<user>\scoop`.
79-
Globally installed programs (`--global`) live in `C:\ProgramData\scoop`.
80-
These settings can be changed through environment variables.
81-
82-
### Install Scoop to a Custom Directory by changing `SCOOP`
83-
84-
```powershell
85-
$env:SCOOP='D:\Applications\Scoop'
86-
[Environment]::SetEnvironmentVariable('SCOOP', $env:SCOOP, 'User')
87-
# run the installer
88-
```
89-
90-
### Configure Scoop to install global programs to a Custom Directory by changing `SCOOP_GLOBAL`
91-
92-
```powershell
93-
$env:SCOOP_GLOBAL='F:\GlobalScoopApps'
94-
[Environment]::SetEnvironmentVariable('SCOOP_GLOBAL', $env:SCOOP_GLOBAL, 'Machine')
95-
# run the installer
96-
```
97-
98-
### Configure Scoop to store downloads to a Custom Directory by changing `SCOOP_CACHE`
99-
100-
```powershell
101-
$env:SCOOP_CACHE='F:\ScoopCache'
102-
[Environment]::SetEnvironmentVariable('SCOOP_CACHE', $env:SCOOP_CACHE, 'Machine')
103-
# run the installer
104-
```
105-
106-
### Configure Scoop to use a GitHub API token during searching and checkver by setting `SCOOP_GH_TOKEN`
107-
108-
```powershell
109-
$env:SCOOP_GH_TOKEN='<paste-token-here>'
110-
[Environment]::SetEnvironmentVariable('SCOOP_GH_TOKEN', $env:SCOOP_GH_TOKEN, 'Machine')
111-
# search for an app
112-
```
67+
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.
11368

11469
## [Documentation](https://github.com/ScoopInstaller/Scoop/wiki)
11570

0 commit comments

Comments
 (0)