Skip to content

Commit aa09601

Browse files
walpoxwalporashil2000
authored
docs(readme): Improve documentation language (ScoopInstaller#5638)
* readme.md: refactor HTML blocks * readme.md: enhance style and fix typos and more * readme.md: improve composition * Update README.md It seems GitHub does not work well with the 'style' attribute, so the deprecated attribute 'align' cannot be replaced. * readme.md: update writing * Update README.md * Update README.md * Update CHANGELOG.md --------- Co-authored-by: walpo <[email protected]> Co-authored-by: Rashil Gandhi <[email protected]>
1 parent 6a35a22 commit aa09601

File tree

2 files changed

+55
-49
lines changed

2 files changed

+55
-49
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
### Documentation
5252

5353
- **scoop-info:** Fix help message([#5445](https://github.com/ScoopInstaller/Scoop/issues/5445))
54+
- **readme:** Improve documentation language ([#5638](https://github.com/ScoopInstaller/Scoop/issues/5638))
5455

5556
## [v0.3.1](https://github.com/ScoopInstaller/Scoop/compare/v0.3.0...v0.3.1) - 2022-11-15
5657

README.md

Lines changed: 54 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
<p align="center">
1+
<h1 align="center">Scoop</h1>
2+
23
<!--<img src="scoop.png" alt="Long live Scoop!"/>-->
3-
<h1 align="center">Scoop</h1>
4-
</p>
54
<p align="center">
6-
<b><a href="https://github.com/ScoopInstaller/Scoop#what-does-scoop-do">Features</a></b>
7-
|
8-
<b><a href="https://github.com/ScoopInstaller/Scoop#installation">Installation</a></b>
9-
|
10-
<b><a href="https://github.com/ScoopInstaller/Scoop/wiki">Documentation</a></b>
5+
<a href="https://github.com/ScoopInstaller/Scoop#what-does-scoop-do">Features</a>
6+
|
7+
<a href="https://github.com/ScoopInstaller/Scoop#installation">Installation</a>
8+
|
9+
<a href="https://github.com/ScoopInstaller/Scoop/wiki">Documentation</a>
1110
</p>
1211

13-
- - -
14-
<p align="center" >
12+
---
13+
14+
<p align="center">
1515
<a href="https://github.com/ScoopInstaller/Scoop">
1616
<img src="https://img.shields.io/github/languages/code-size/ScoopInstaller/Scoop.svg" alt="Code Size" />
1717
</a>
@@ -36,43 +36,48 @@ Scoop is a command-line installer for Windows.
3636

3737
## What does Scoop do?
3838

39-
Scoop installs programs from the command line with a minimal amount of friction. It:
39+
Scoop installs apps from the command line with a minimal amount of friction. It:
4040

41-
- Eliminates permission popup windows
42-
- Hides GUI wizard-style installers
43-
- Prevents PATH pollution from installing lots of programs
44-
- Avoids unexpected side-effects from installing and uninstalling programs
45-
- Finds and installs dependencies automatically
46-
- Performs all the extra setup steps itself to get a working program
41+
- Eliminates [User Account Control](https://learn.microsoft.com/windows/security/application-security/application-control/user-account-control/) (UAC) prompt notifications.
42+
- Hides the graphical user interface (GUI) of wizard-style installers.
43+
- Prevents polluting the `PATH` environment variable. Normally, this variable gets cluttered as different apps are installed on the device.
44+
- Avoids unexpected side effects from installing and uninstalling apps.
45+
- Resolves and installs dependencies automatically.
46+
- Performs all the necessary steps to get an app to a working state.
4747

48-
Scoop is very scriptable, so you can run repeatable setups to get your environment just the way you like, e.g.:
48+
Scoop is quite script-friendly. Your environment can become the way you like by using repeatable setups. For example:
4949

50-
```powershell
50+
```console
5151
scoop install sudo
5252
sudo scoop install 7zip git openssh --global
5353
scoop install aria2 curl grep sed less touch
5454
scoop install python ruby go perl
5555
```
5656

57-
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.
57+
If you have built software that you would like others to use, Scoop is an alternative to building an installer (like MSI or InnoSetup). You just need to compress your app to a `.zip` file and provide a JSON manifest that describes how to install it.
5858

5959
## Installation
6060

61-
Run the following command from a **non-admin** PowerShell to install scoop to its default location `C:\Users\<YOUR USERNAME>\scoop`.
61+
Run the following commands from a regular (non-admin) PowerShell terminal to install Scoop:
6262

6363
```powershell
64-
iwr -useb get.scoop.sh | iex
64+
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
65+
Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
6566
```
6667

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.
68+
**Note**: The first command makes your device allow running the installation and management scripts. This is necessary because Windows 10 client devices restrict execution of any PowerShell scripts by default.
6869

69-
## [Documentation](https://github.com/ScoopInstaller/Scoop/wiki)
70+
It will install Scoop to its default location:
71+
72+
`C:\Users\<YOUR USERNAME>\scoop`
73+
74+
You can find the complete documentation about the installer, including advanced installation configurations, in [ScoopInstaller/Install](https://github.com/ScoopInstaller/Install). Please create new issues there if you have questions about the installation.
7075

7176
## Multi-connection downloads with `aria2`
7277

7378
Scoop can utilize [`aria2`](https://github.com/aria2/aria2) to use multi-connection downloads. Simply install `aria2` through Scoop and it will be used for all downloads afterward.
7479

75-
```powershell
80+
```console
7681
scoop install aria2
7782
```
7883

@@ -90,54 +95,54 @@ You can tweak the following `aria2` settings with the `scoop config` command:
9095

9196
## Inspiration
9297

93-
- [Homebrew](http://mxcl.github.io/homebrew/)
94-
- [sub](https://github.com/37signals/sub#readme)
98+
- [Homebrew](https://brew.sh/)
99+
- [Sub](https://signalvnoise.com/posts/3264-automating-with-convention-introducing-sub)
95100

96101
## What sort of apps can Scoop install?
97102

98-
The apps that install best with Scoop are commonly called "portable" apps: i.e. compressed program files that run stand-alone when extracted and don't have side-effects like changing the registry or putting files outside the program directory.
99-
100-
Since installers are common, Scoop supports them too (and their uninstallers).
103+
The apps that are most likely to get installed fine with Scoop are those referred to as "portable" apps. These apps are compressed files which can run standalone after being extracted. This type of apps does not produce side effects like changing the Windows Registry or placing files outside the app directory.
101104

102-
Scoop is also great at handling single-file programs and Powershell scripts. These don't even need to be compressed. See the [runat](https://github.com/ScoopInstaller/Main/blob/master/bucket/runat.json) package for an example: it's really just a GitHub gist.
105+
Scoop also supports installer files and their uninstallation methods. Likewise, it can handle single-file apps and PowerShell scripts. These do not even need to be compressed. See the [runat](https://github.com/ScoopInstaller/Main/blob/master/bucket/runat.json) package for an example: it is simply a GitHub gist.
103106

104107
### Contribute to this project
105108

106-
If you'd like to improve Scoop by adding features or fixing bugs, please read our [Contributing Guide](https://github.com/ScoopInstaller/.github/blob/main/.github/CONTRIBUTING.md).
109+
If you would like to improve Scoop by adding features or fixing bugs, please read our [Contributing Guide](https://github.com/ScoopInstaller/.github/blob/main/.github/CONTRIBUTING.md).
107110

108111
### Support this project
109112

110-
If you find Scoop useful and would like to support ongoing development and maintenance, here's how:
113+
If you find Scoop useful and would like to support the ongoing development and maintenance of this project, you can donate here:
111114

112-
- [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=DM2SUH9EUXSKJ) (one-time donation)
115+
- [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=DM2SUH9EUXSKJ) (one-time donations)
113116

114117
## Known application buckets
115118

116-
The following buckets are known to scoop:
119+
The following buckets are known to Scoop:
117120

118-
- [main](https://github.com/ScoopInstaller/Main) - Default bucket for the most common (mostly CLI) apps
119-
- [extras](https://github.com/ScoopInstaller/Extras) - Apps that don't fit the main bucket's [criteria](https://github.com/ScoopInstaller/Scoop/wiki/Criteria-for-including-apps-in-the-main-bucket)
120-
- [games](https://github.com/Calinou/scoop-games) - Open source/freeware games and game-related tools
121-
- [nerd-fonts](https://github.com/matthewjberger/scoop-nerd-fonts) - Nerd Fonts
122-
- [nirsoft](https://github.com/ScoopInstaller/Nirsoft) - Almost all of the 280+ apps from [Nirsoft](https://nirsoft.net)
123-
- [sysinternals](https://github.com/niheaven/scoop-sysinternals) - Sysinternals Suite and all individual applications from [Microsoft](https://learn.microsoft.com/sysinternals/)
124-
- [java](https://github.com/ScoopInstaller/Java) - A collection of Java development kits (JDKs), Java runtime engines (JREs), Java's virtual machine debugging tools and Java based runtime engines.
125-
- [nonportable](https://github.com/ScoopInstaller/Nonportable) - Non-portable apps (may require UAC/Administrator rights)
126-
- [php](https://github.com/ScoopInstaller/PHP) - Installers for most versions of PHP
127-
- [versions](https://github.com/ScoopInstaller/Versions) - Alternative versions of apps found in other buckets
121+
- [main](https://github.com/ScoopInstaller/Main) - Default bucket which contains popular non-GUI apps.
122+
- [extras](https://github.com/ScoopInstaller/Extras) - Apps that do not fit the main bucket's [criteria](https://github.com/ScoopInstaller/Scoop/wiki/Criteria-for-including-apps-in-the-main-bucket).
123+
- [games](https://github.com/Calinou/scoop-games) - Open-source and freeware video games and game-related tools.
124+
- [nerd-fonts](https://github.com/matthewjberger/scoop-nerd-fonts) - Nerd Fonts.
125+
- [nirsoft](https://github.com/ScoopInstaller/Nirsoft) - A collection of over 250+ apps from [Nirsoft](https://nirsoft.net).
126+
- [sysinternals](https://github.com/niheaven/scoop-sysinternals) - The Sysinternals suite from [Microsoft](https://learn.microsoft.com/sysinternals/).
127+
- [java](https://github.com/ScoopInstaller/Java) - A collection of Java development kits (JDKs) and Java runtime engines (JREs), Java's virtual machine debugging tools and Java based runtime engines.
128+
- [nonportable](https://github.com/ScoopInstaller/Nonportable) - Non-portable apps (may trigger UAC prompts).
129+
- [php](https://github.com/ScoopInstaller/PHP) - Installers for most versions of PHP.
130+
- [versions](https://github.com/ScoopInstaller/Versions) - Alternative versions of apps found in other buckets.
128131

129-
The main bucket is installed by default. To add any of the other buckets, type:
132+
The `main` bucket is installed by default. You can make use of more buckets by typing:
130133

131134
```console
132-
scoop bucket add bucketname
135+
scoop bucket add <name>
133136
```
134137

135-
For example, to add the extras bucket, type:
138+
For example, to add the `extras` bucket, type:
136139

137140
```console
138141
scoop bucket add extras
139142
```
140143

144+
You would be able to install apps from the `extras` bucket now.
145+
141146
## Other application buckets
142147

143-
Many other application buckets hosted on Github can be found in the [Scoop Directory](https://rasa.github.io/scoop-directory/) or via [other search engines](https://rasa.github.io/scoop-directory/#other-search-engines).
148+
Many other application buckets hosted on GitHub can be found on [ScoopSearch](https://scoop.sh/) or via [other search engines](https://rasa.github.io/scoop-directory/#other-search-engines).

0 commit comments

Comments
 (0)