Skip to content

Commit 2f793ba

Browse files
committed
Update README.md with new development instructions
1 parent 5da7292 commit 2f793ba

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,42 @@ how to use this project. You can also read our plans for future feature developm
3737

3838
**TODO**: Add information about acquiring packages from NuGet and npm once those are available.
3939

40-
## Cloning the Code
40+
## Development
4141

42-
To clone the repository execute:
42+
43+
### 1. Install PowerShell if necessary
44+
45+
If you are using Windows, skip this step. If you are using Linux or macOS, you will need to
46+
install PowerShell by following [these instructions](https://github.com/PowerShell/PowerShell#get-powershell).
47+
48+
### 2. Clone the GitHub repository:
4349

4450
```
4551
git clone https://github.com/PowerShell/PowerShellEditorServices.git
4652
```
4753

54+
### 3. Install [Invoke-Build](https://github.com/nightroman/Invoke-Build)
55+
56+
This step requires PowerShellGet, included by default with PowerShell v5 and up
57+
but installable on [PowerShell v3 and v4](https://github.com/PowerShell/PowerShellGet#get-powershellget-module-for-powershell-versions-30-and-40).
58+
59+
```powershell
60+
Install-Module InvokeBuild -Scope CurrentUser
61+
```
62+
63+
Now you're ready to build the code. You can do so in one of two ways:
64+
65+
### Building the code from PowerShell
66+
67+
```powershell
68+
PS C:\path\to\PowerShellEditorServices> Invoke-Build Build
69+
```
70+
71+
### Building the code from Visual Studio Code
72+
73+
Open the PowerShellEditorServices folder that you cloned locally and press <kbd>Ctrl+Shift+B</kbd>
74+
(or <kbd>Cmd+Shift+B</kbd> on macOS).
75+
4876
## Contributions Welcome!
4977

5078
We would love to incorporate community contributions into this project. If you would like to

0 commit comments

Comments
 (0)