Skip to content

Commit cd993ce

Browse files
committed
Edit Standard Input and Output section in README
1 parent 64c16e7 commit cd993ce

1 file changed

Lines changed: 16 additions & 13 deletions

File tree

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -121,37 +121,40 @@ and IntelliJ.
121121

122122
### Standard Input and Output
123123

124-
Connecting to PSES over standard input and output (stdio) is the simplest option in most LSP clients.
124+
Connecting to PSES over standard input and output (stdio) is the simplest option
125+
in most LSP clients.
125126

126127
> [!NOTE]
127-
> Some features are not available over stdio, such as the debugger and Extension
128-
> Terminal, because they require their own IO streams and stdio provides a single
129-
> pair of streams.
128+
> Some PSES features are not available over stdio, such as the debugger and
129+
> Extension Terminal, because they require their own IO streams and stdio
130+
> provides a single pair of streams.
130131
131132
Use PSES over stdio as follows:
132133

133134
```powershell
134135
pwsh -NoLogo -NoProfile -Command "./PowerShellEditorServices/Start-EditorServices.ps1 -Stdio -LogLevel Error"
135136
```
136137

138+
The script **Start-EditorServices.ps1** is located inside the
139+
**PowerShellEditorServices** directory. See [Manual Installation](#manual-installation).
140+
137141
> [!IMPORTANT]
138-
> Adjust the path to `Start-EditorServices.ps1` as needed. The command above assumes
139-
> that the current directory is set to the folder where you expanded the PSES ZIP
140-
> archive to.
141-
>
142-
> Depending on your editor, set the environment variables `NO_COLOR` and `TERM`
143-
> before issuing the command above to improve the readability of any error messages
144-
> `pwsh` may output. See [Disabling ANSI Output](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_ansi_terminals#disabling-ansi-output)
142+
> Depending on your editor, consider setting the environment variables
143+
> `NO_COLOR` and `TERM` before executing the command above to improve the
144+
> readability of any error messages output by `pwsh`. See [Disabling ANSI Output][disabling-ansi-output]
145145
> for more details.
146146
147-
For examples of tested end-to-end configurations, see:
147+
[disabling-ansi-output]: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_ansi_terminals#disabling-ansi-output
148+
149+
For examples of tested sdtio-based configurations, see:
148150

149151
- [emacs-simple-test.el](test/emacs-simple-test.el)
150152
- [emacs-test.el](test/emacs-test.el)
151153
- [vim-simple-test.vim](test/vim-simple-test.vim)
152154
- [vim-test.vim](test/vim-test.vim)
153155

154-
They use [eglot for Emacs](https://github.com/joaotavora/eglot) and [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim).
156+
The examples above use [eglot for Emacs](https://github.com/joaotavora/eglot)
157+
and [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim).
155158

156159
### Advanced Usage
157160

0 commit comments

Comments
 (0)