Skip to content

Commit 8946cd9

Browse files
committed
edit CONTRIBUTING.md
1 parent aaefd03 commit 8946cd9

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
## Contributing
22

3-
43
Thanks for taking an insterest in contributing to the PowerShell package for
54
Sublime Text 3!
65

@@ -11,6 +10,32 @@ Development happens on the **dev** branch. Please send your PRs against that
1110
branch only.
1211

1312

13+
### Building Development Versions
14+
15+
To build development versions, first you need a configuration file in
16+
`$env:USERPROFILE\sublime-package-dev.json`.
17+
18+
This file must contain the following information:
19+
20+
{
21+
"pathToSublimeText": "...\sublime_text.exe",
22+
"pathToSublimeTextData": "...\
23+
}
24+
25+
26+
#### Using Sublime Text
27+
28+
1. Press <kbd>Ctrl+Shift+B</kbd> to open the build systems menu.
29+
2. Select 'PowerShell: Build Dev Version'
30+
31+
32+
#### Using the Command Line
33+
34+
From the project's root:
35+
36+
.\bin\BuildFolder.ps1 -verbose
37+
38+
1439
#### Running Tests
1540

1641
If you are adding functionality or making substantial changes to existing
@@ -20,12 +45,3 @@ Currently, we have very few tests and they aren't easy to run... :-(
2045

2146
If you feel lazy about writing tests, this is the right time to contribute --
2247
we'll turn a blind eye more often now than later on! ;-)
23-
24-
25-
### Building Versions
26-
27-
The easiest way to 'build' a version now consists in copying the project's
28-
root folder's content to your *Data/Packages/PowerShell* directory.
29-
30-
We have build scripts under *.\bin*, but they aren't realiable. We hope to fix
31-
that soon.

0 commit comments

Comments
 (0)