Skip to content

Commit d61e066

Browse files
committed
Small cleanup of development instructions
1 parent f07c7fd commit d61e066

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

docs/development.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,48 +5,52 @@
55
You'll need to clone two repositories and set up your development environment
66
to before you can proceed.
77

8-
1. [Fork and clone](https://help.github.com/articles/fork-a-repo/) the [vscode-powershell repository](https://github.com/PowerShell/vscode-powershell)
8+
1. [Fork and clone][fork] the [vscode-powershell repository](https://github.com/PowerShell/vscode-powershell)
99

10-
2. [Fork and clone](https://help.github.com/articles/fork-a-repo/) the [PowerShell Editor Services (PSES) repository](https://github.com/PowerShell/PowerShellEditorServices)
10+
2. [Fork and clone][fork] the [PowerShell Editor Services (PSES) repository](https://github.com/PowerShell/PowerShellEditorServices)
11+
> The `vscode-powershell` folder and the `PowerShellEditorServices` folder should be next to each other on the file
12+
> system. Code in `vscode-powershell` looks for PSES at `../PowerShellEditorServices` if you're building locally so
13+
> PSES must be in that location.
1114
12-
> NOTE: the `vscode-powershell` folder and the `PowerShellEditorServices` folder should be next to each other on the file system. Code in `vscode-powershell` looks for PSES at `../PowerShellEditorServices` if you're building locally so PSES must be in that location.
13-
14-
3. Follow the [development instructions](https://github.com/PowerShell/PowerShellEditorServices#development) for PowerShell Editor Services. **You will need to complete this step before proceeding**.
15+
3. Follow the [development instructions](https://github.com/PowerShell/PowerShellEditorServices#development) for
16+
PowerShell Editor Services. **You will need to complete this step before proceeding**.
1517

1618
4. Install the latest [Visual Studio Code Insiders release](https://code.visualstudio.com/insiders)
17-
- You can also use the [standard Visual Studio Code release](https://code.visualstudio.com/). Both will work, but using VSCode
18-
Insiders means the extension can be developed ready for new features
19-
and changes in the next VSCode release.
19+
> You can also use the [standard Visual Studio Code release](https://code.visualstudio.com/). Both will work, but
20+
> using VSCode Insiders means the extension can be developed ready for new features and changes in the next VSCode
21+
> release.
2022
2123
5. Install [Node.js](https://nodejs.org/en/) 10.x or higher.
2224

23-
## Building the Code
25+
[fork]: https://help.github.com/articles/fork-a-repo/
26+
27+
### Building the Code
2428

25-
#### From Visual Studio Code:
29+
#### From Visual Studio Code
2630

27-
Press <kbd>Ctrl</kbd>+<kbd>P</kbd> and type `task build`
31+
> Press <kbd>Ctrl</kbd>+<kbd>P</kbd> and type `task build`
2832
2933
This will compile the TypeScript files in the project to JavaScript files.
3034

31-
#### From a PowerShell prompt:
35+
#### From a PowerShell prompt
3236

33-
```
37+
```powershell
3438
Invoke-Build Build
3539
```
3640

37-
## Launching the extension
41+
### Launching the extension
3842

39-
#### From Visual Studio Code:
43+
#### From Visual Studio Code
4044

41-
To debug the extension, press <kbd>F5</kbd>. To run the extension without debugging,
42-
press <kbd>Ctrl</kbd>+<kbd>F5</kbd> or <kbd>Cmd</kbd>+<kbd>F5</kbd> on macOS.
45+
> To debug the extension, press <kbd>F5</kbd>. To run the extension without debugging, press
46+
> <kbd>Ctrl</kbd>+<kbd>F5</kbd> or <kbd>Cmd</kbd>+<kbd>F5</kbd> on macOS.
4347
44-
#### From a command prompt:
48+
#### From a command prompt
4549

46-
```
50+
```cmd
4751
code --extensionDevelopmentPath="c:\path\to\vscode-powershell" .
4852
```
4953

5054
## Contributing Snippets
5155

52-
For more information on contributing snippets please read our [snippet requirements](https://github.com/PowerShell/vscode-powershell/blob/master/docs/community_snippets.md#contributing).
56+
For more information on contributing snippets please read our [snippet requirements](https://github.com/PowerShell/vscode-powershell/blob/master/docs/community_snippets.md#contributing).

0 commit comments

Comments
 (0)