|
1 |
| -Status: [](https://ci.appveyor.com/project/guillermooo/powershell/branch/dev) |
| 1 | +[](https://ci.appveyor.com/project/guillermooo/powershell/branch/dev) |
2 | 2 |
|
3 |
| -PowerShell |
4 |
| -========== |
5 | 3 |
|
6 |
| -Support for the MS PowerShell programming language. |
| 4 | +## PowerShell Package for Sublime Text 3 |
7 | 5 |
|
| 6 | +Adds support for the MS PowerShell programming language. |
8 | 7 |
|
9 |
| -# Install |
| 8 | + |
| 9 | +### Installing |
10 | 10 |
|
11 | 11 | 1. Install [package control][package_control] for Sublime Text.
|
12 | 12 | 1. Install the **PowerShell** package:
|
13 | 13 |
|
14 |
| - 1. `Ctrl + Shift + P` |
15 |
| - 1. `install` |
16 |
| - 1. `powershell` |
17 |
| - |
18 |
| - |
19 |
| -# Development |
20 |
| - |
21 |
| - |
22 |
| -## Requirements |
23 |
| - |
24 |
| -- Python 3.3 (for build scripts) |
25 |
| - |
26 |
| - |
27 |
| -## Publishing This Package Locally as a Directory |
28 |
| - |
29 |
| -**This is the recommended way of testing this package locally.** |
30 |
| - |
31 |
| -First of all, you need to create a config file: |
32 |
| - |
33 |
| - |
34 |
| -``` |
35 |
| -%HOME%/.sublime-package-dev |
36 |
| -``` |
37 |
| - |
38 |
| -Add this content: |
39 |
| - |
40 |
| -``` |
41 |
| -global-win editor ~/path/to/sublime_text.exe |
42 |
| -global-win installed-packages ~/path/to/sublime-text/Installed Packages |
43 |
| -``` |
44 |
| - |
45 |
| -1. Clone [this repo][this_repo] to a folder of your choice |
46 |
| -1. Make sure you have no *PowerShell.sublime-package* under the |
47 |
| - `{Data}/Installed Packages` directory. |
48 |
| -1. Run *./bin/Build-Folder.ps1* on the command line. |
49 |
| - |
50 |
| - |
51 |
| -## Generating `PowerShell.sublime-package` |
52 |
| - |
53 |
| -**This method is not recommended at present.** |
54 |
| - |
55 |
| -First of all, you need to create a config file: |
56 |
| - |
57 |
| - |
58 |
| -``` |
59 |
| -%HOME%/.sublime-package-dev |
60 |
| -``` |
61 |
| - |
62 |
| -Add this content: |
63 |
| - |
64 |
| -``` |
65 |
| -global-win editor ~/path/to/sublime_text.exe |
66 |
| -global-win installed-packages ~/path/to/sublime-text/Installed Packages |
67 |
| -``` |
68 |
| - |
69 |
| -- Clone [this repo][this_repo] to a folder of your choice |
70 |
| -- Open the `PowerShell.sublime-project` included as a project |
71 |
| -- Select Tools → Build Systems → Run |
72 |
| -- Press <kbd>F7</kbd> to build and publish locally a new dev version |
73 |
| - |
74 |
| - |
75 |
| -## Syntax |
76 |
| - |
77 |
| -The plist file [PowershellSyntax.tmLanguage](Support/PowershellSyntax.tmLanguage) |
78 |
| -is the syntax definition's master file. |
79 |
| - |
80 |
| -However, the [recommended way][syntax_topic] to edit the syntax definition |
81 |
| -is YAML format. To use this format, follow these steps: |
82 |
| - |
83 |
| -1. Using Package Control, install the `AAAPackageDev` package. |
84 |
| -1. Open **PowershellSyntax.tmLanguage**. |
85 |
| -1. Call `Ctrl + Shift + P` + `convert to Yaml and Rearrange`. |
86 |
| - You will get a new file: **Support/PowershellSyntax.YAML-tmLanguage**. |
87 |
| -1. Edit the YAML file. |
88 |
| -1. Call `Ctrl + Shift + P` + `convert (YAML, JSON, Plist) to`. |
89 |
| - You will get and updated version of the plist file. |
90 |
| - |
91 |
| - |
92 |
| -## Running the Test Suite |
93 |
| - |
94 |
| -### Requirements |
95 |
| - |
96 |
| -- UnitTesting (install via [Package Control][package_control]) |
97 |
| - |
98 |
| -### How to Run the Tests |
99 |
| - |
100 |
| -Open the command palette, then select 'UnitTesting'. Type in 'PowerShell' and |
101 |
| -press enter. |
| 14 | + 1. Press <kbd>Ctrl + Shift + P</kbd> |
| 15 | + 1. Select 'Install Package' |
| 16 | + 1. Select 'PowerShell' |
102 | 17 |
|
103 | 18 |
|
104 |
| -## Contributing |
| 19 | +### Developing |
105 | 20 |
|
106 |
| -See [CONTRIBUTING.md](CONTRIBUTING.md). |
| 21 | +You want to contribute? Awesome! Take a look at [CONTRIBUTING.md](CONTRIBUTING.md). |
107 | 22 |
|
108 | 23 |
|
109 | 24 | [package_control]: https://sublime.wbond.net/installation
|
110 |
| -[this_repo]: https://github.com/SublimeText/PowerShell |
111 |
| -[syntax_topic]: http://sublime-text-unofficial-documentation.readthedocs.org/en/latest/extensibility/syntaxdefs.html |
0 commit comments