Skip to content

Commit 4fe166e

Browse files
authored
Update README.md to put 'PSReadLine' and 'PowerShellGet' in backtick quotes (#1280)
1 parent ef5c226 commit 4fe166e

File tree

2 files changed

+24
-21
lines changed

2 files changed

+24
-21
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ PSReadline.zip
88
[Bb]in/
99
[Oo]bj/
1010

11+
# VSCode directories that are not at the repository root
12+
/**/.vscode/
13+
1114
# mstest test results
1215
TestResults
1316
FakesAssemblies/

README.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -30,34 +30,34 @@ It provides:
3030

3131
The "out of box" experience is meant to be very familiar to PowerShell users - there should be no need to learn any new key strokes.
3232

33-
Keith Hill wrote a great introduction to PSReadLine [here](http://rkeithhill.wordpress.com/2013/10/18/psreadline-a-better-line-editing-experience-for-the-powershell-console/).
33+
Keith Hill wrote a great introduction to `PSReadLine` [here](http://rkeithhill.wordpress.com/2013/10/18/psreadline-a-better-line-editing-experience-for-the-powershell-console/).
3434

35-
Ed Wilson (Scripting Guy) wrote a series on PSReadLine, starting [here](http://blogs.technet.com/b/heyscriptingguy/archive/2014/06/16/the-search-for-a-better-powershell-console-experience.aspx).
35+
Ed Wilson (Scripting Guy) wrote a series on `PSReadLine`, starting [here](http://blogs.technet.com/b/heyscriptingguy/archive/2014/06/16/the-search-for-a-better-powershell-console-experience.aspx).
3636

3737
## Installation
3838

39-
There are multiple ways to install PSReadLine.
39+
There are multiple ways to install `PSReadLine`.
4040

4141
### Install from PowerShellGallery (preferred)
4242

43-
You will need the 1.6.0 or a higher version of [PowerShellGet](https://docs.microsoft.com/powershell/scripting/gallery/installing-psget) to install the latest prerelease version of PSReadLine.
43+
You will need the `1.6.0` or a higher version of [`PowerShellGet`](https://docs.microsoft.com/powershell/scripting/gallery/installing-psget) to install the latest prerelease version of `PSReadLine`.
4444

45-
Windows PowerShell 5.1 ships an older version of PowerShellGet which doesn't support installing prerelease modules,
46-
so Windows PowerShell users need to install the latest PowerShellGet (if not yet) by running the following commands from an elevated Windows PowerShell session:
45+
Windows PowerShell 5.1 ships an older version of `PowerShellGet` which doesn't support installing prerelease modules,
46+
so Windows PowerShell users need to install the latest `PowerShellGet` (if not yet) by running the following commands from an elevated Windows PowerShell session:
4747

4848
```powershell
4949
Install-Module -Name PowerShellGet -Force
5050
Exit
5151
```
5252

53-
After installing PowerShellGet, you can simply run `Install-Module PSReadLine -AllowPrerelease -Force` to get the latest prerelease version of PSReadLine.
53+
After installing `PowerShellGet`, you can simply run `Install-Module PSReadLine -AllowPrerelease -Force` to get the latest prerelease version of `PSReadLine`.
5454
If you only want to get the latest stable version, run `Install-Module PSReadLine`.
5555

5656
>[!NOTE] Prerelease versions will have newer features and bug fixes, but may also introduce new issues.
5757
58-
If you are using Windows PowerShell on Windows 10 or using PowerShell 6+, PSReadLine is already installed.
59-
Windows PowerShell on the latest Windows 10 has version `2.0.0-beta2` of PSReadLine.
60-
PowerShell 6+ versions have the newer prerelease versions of PSReadLine.
58+
If you are using Windows PowerShell on Windows 10 or using PowerShell 6+, `PSReadLine` is already installed.
59+
Windows PowerShell on the latest Windows 10 has version `2.0.0-beta2` of `PSReadLine`.
60+
PowerShell 6+ versions have the newer prerelease versions of `PSReadLine`.
6161

6262
### Install from GitHub (deprecated)
6363

@@ -91,15 +91,15 @@ In either case, you can create the appropriate file if you don't already have on
9191
## Upgrading
9292

9393
When running one of the suggested commands below, be sure to exit all instances of `powershell.exe`, `pwsh.exe` or `pwsh`,
94-
then run the suggested command from `cmd.exe`, `powershell_ise.exe`, or via the `Win+R` shortcut to make sure PSReadLine isn't loaded.
94+
then run the suggested command from `cmd.exe`, `powershell_ise.exe`, or via the `Win+R` shortcut to make sure `PSReadLine` isn't loaded.
9595

96-
If you are using the version of PSReadLine that ships with Windows PowerShell,
96+
If you are using the version of `PSReadLine` that ships with Windows PowerShell,
9797
you need to run: `powershell -noprofile -command "Install-Module PSReadLine -Force -SkipPublisherCheck -AllowPrerelease"`.
9898

99-
If you are using the version of PSReadLine that ships with PowerShell 6+ versions,
99+
If you are using the version of `PSReadLine` that ships with PowerShell 6+ versions,
100100
you need to run: `<path-to-pwsh-executable> -noprofile -command "Install-Module PSReadLine -Force -SkipPublisherCheck -AllowPrerelease"`.
101101

102-
If you've installed PSReadLine yourself from the PowerShell Gallery,
102+
If you've installed `PSReadLine` yourself from the PowerShell Gallery,
103103
you can simply run: `powershell -noprofile -command "Update-Module PSReadLine -AllowPrerelease"` or
104104
`<path-to-pwsh-executable> -noprofile -command "Update-Module PSReadLine -AllowPrerelease"`,
105105
depending on the version of PowerShell you are using.
@@ -112,7 +112,7 @@ C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PSReadLine\Microsoft.Pow
112112
'C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PSReadLine\Microsoft.PowerShell.PSReadLine.dll' is denied.
113113
```
114114

115-
Then you didn't kill all the processes that loaded PSReadLine.
115+
Then you didn't kill all the processes that loaded `PSReadLine`.
116116

117117
## Usage
118118

@@ -134,9 +134,9 @@ To view the current key bindings:
134134
Get-PSReadLineKeyHandler
135135
```
136136

137-
There are many configuration options, see the options to Set-PSReadLineOption. PSReadLine has help for it's cmdlets as well as an about_PSReadLine topic - see those topics for more detailed help.
137+
There are many configuration options, see the options to `Set-PSReadLineOption`. `PSReadLine` has help for it's cmdlets as well as an `about_PSReadLine` topic - see those topics for more detailed help.
138138

139-
To set your own custom keybindings, use the cmdlet Set-PSReadLineKeyHandler. For example, for a better history experience, try:
139+
To set your own custom keybindings, use the cmdlet `Set-PSReadLineKeyHandler`. For example, for a better history experience, try:
140140

141141
```powershell
142142
Set-PSReadLineKeyHandler -Key UpArrow -Function HistorySearchBackward
@@ -181,9 +181,9 @@ In this example, when you type a single quote or double quote, there are two thi
181181

182182
Note that with the handler written this way, it correctly handles Undo - both quotes will be undone with one undo.
183183

184-
The [sample profile file](https://github.com/PowerShell/PSReadLine/blob/master/PSReadLine/SamplePSReadLineProfile.ps1) has a bunch of great examples to check out. This file is included when PSReadLine is installed.
184+
The [sample profile file](https://github.com/PowerShell/PSReadLine/blob/master/PSReadLine/SamplePSReadLineProfile.ps1) has a bunch of great examples to check out. This file is included when `PSReadLine` is installed.
185185

186-
See the public methods of [Microsoft.PowerShell.PSConsoleReadLine] to see what other built-in functionality you can modify.
186+
See the public methods of `[Microsoft.PowerShell.PSConsoleReadLine]` to see what other built-in functionality you can modify.
187187

188188
If you want to change the command line in some unimplmented way in your custom key binding, you can use the methods:
189189

@@ -198,8 +198,8 @@ If you want to change the command line in some unimplmented way in your custom k
198198

199199
### Prerequisites
200200

201-
To build PSReadLine on Windows, Linux, or macOS, you must have [.NET Core SDK 2.1.400 or newer](https://www.microsoft.com/net/download) installed.
202-
The build script also depends on [InvokeBuild](https://www.powershellgallery.com/packages/InvokeBuild) which can be installed using:
201+
To build `PSReadLine` on Windows, Linux, or macOS, you must have [.NET Core SDK 2.1.400 or newer](https://www.microsoft.com/net/download) installed.
202+
The build script also depends on [`InvokeBuild`](https://www.powershellgallery.com/packages/InvokeBuild) which can be installed using:
203203

204204
```powershell
205205
install-module invokebuild -scope currentuser

0 commit comments

Comments
 (0)