Skip to content

Commit bdbfaf3

Browse files
committed
edit readme
1 parent 3ba7f24 commit bdbfaf3

File tree

1 file changed

+42
-3
lines changed

1 file changed

+42
-3
lines changed

README.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,34 @@ Support for the MS PowerShell programming language.
2222
- Python 3.3 (for build scripts)
2323

2424

25+
## Publishing This Package Locally as a Directory
26+
27+
**This is the recommended way of testing this package locally.**
28+
29+
First of all, you need to create a config file:
30+
31+
32+
```
33+
%HOME%/.sublime-package-dev
34+
```
35+
36+
Add this content:
37+
38+
```
39+
global-win editor ~/path/to/sublime_text.exe
40+
global-win installed-packages ~/path/to/sublime-text/Installed Packages
41+
```
42+
43+
1 Clone [this repo][this_repo] to a folder of your choice
44+
1. Make sure you have no *PowerShell.sublime-package* under the
45+
`{Data}/Installed Packages` directory.
46+
1. Run *./bin/Build-Folder.ps1* on the command line.
47+
48+
2549
## Generating `PowerShell.sublime-package`
2650

51+
**This method is not recommended at present.**
52+
2753
First of all, you need to create a config file:
2854

2955

@@ -61,10 +87,23 @@ is YAML format. To use this format, follow these steps:
6187
You will get and updated version of the plist file.
6288

6389

64-
[package_control]: https://sublime.wbond.net/installation
65-
[this_repo]: https://github.com/SublimeText/PowerShell
66-
[syntax_topic]: http://sublime-text-unofficial-documentation.readthedocs.org/en/latest/extensibility/syntaxdefs.html
90+
## Running the Test Suite
91+
92+
### Requirements
93+
94+
- UnitTesting (install via [Package Control][package_control])
95+
96+
### How to Run the Tests
97+
98+
Open the command palette, then select 'UnitTesting'. Type in 'PowerShell' and
99+
press enter.
100+
67101

68102
## Contributing
69103

70104
See [CONTRIBUTING.md](CONTRIBUTING.md).
105+
106+
107+
[package_control]: https://sublime.wbond.net/installation
108+
[this_repo]: https://github.com/SublimeText/PowerShell
109+
[syntax_topic]: http://sublime-text-unofficial-documentation.readthedocs.org/en/latest/extensibility/syntaxdefs.html

0 commit comments

Comments
 (0)