Skip to content

Commit e681b87

Browse files
committed
Merge pull request #35 from my-personal-forks/readme
edit readme
2 parents 311af82 + f7384bb commit e681b87

File tree

1 file changed

+33
-13
lines changed

1 file changed

+33
-13
lines changed

README.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,41 @@ PowerShell
33

44
Support for the MS PowerShell programming language.
55

6+
67
# Install
7-
1. Install [package control](https://sublime.wbond.net/installation) for Sublime Text.
8-
1. Install package **PowerShell** (`Ctrl + Shift + P` + `install` + `powershell`)
8+
9+
1. Install [package control][package_control] for Sublime Text.
10+
1. Install the **PowerShell** package:
11+
12+
1. `Ctrl + Shift + P`
13+
1. `install`
14+
1. `powershell`
15+
916

1017
# Development
11-
1. Open sublime packages folder (`Ctrl + Shift + P` + `browse packages`)
12-
1. Clone [this repo](https://github.com/SublimeText/PowerShell) to packages folder.
13-
Now your local version of package is available in sublime.
18+
19+
1. Open the Sublime Text packages folder (`Ctrl + Shift + P` + `browse packages`)
20+
1. Clone [this repo][this_repo] to the packages folder
21+
Now your local version of this package is available in Sublime Text.
22+
1423

1524
## Syntax
16-
Plist file [PowershellSyntax.tmLanguage](Support/PowershellSyntax.tmLanguage) is the master file for syntax.
17-
But the [recommended way](http://sublime-text-unofficial-documentation.readthedocs.org/en/latest/extensibility/syntaxdefs.html) to develop syntax is YAML.
18-
19-
1. Install `AAAPackageDev` package.
20-
1. Open **PowershellSyntax.tmLanguage**
21-
1. Call `Ctrl + Shift + P` + `convert to Yaml and Rearrange`. You will get new file **Support/PowershellSyntax.YAML-tmLanguage**.
22-
1. Make your changes in YAML file.
23-
1. Call `Ctrl + Shift + P` + `convert (YAML, JSON, Plist) to`. You will get updated version of plist file.
25+
26+
The plist file [PowershellSyntax.tmLanguage](Support/PowershellSyntax.tmLanguage)
27+
is the syntax definition's master file.
28+
29+
However, the [recommended way][syntax_topic] to edit the syntax definition
30+
is YAML format. To use this format, follow these steps:
31+
32+
1. Using Package Control, install the `AAAPackageDev` package.
33+
1. Open **PowershellSyntax.tmLanguage**.
34+
1. Call `Ctrl + Shift + P` + `convert to Yaml and Rearrange`.
35+
You will get a new file: **Support/PowershellSyntax.YAML-tmLanguage**.
36+
1. Edit the YAML file.
37+
1. Call `Ctrl + Shift + P` + `convert (YAML, JSON, Plist) to`.
38+
You will get and updated version of the plist file.
39+
40+
41+
[package_control]: https://sublime.wbond.net/installation
42+
[this_repo]: https://github.com/SublimeText/PowerShell
43+
[syntax_topic]: http://sublime-text-unofficial-documentation.readthedocs.org/en/latest/extensibility/syntaxdefs.html

0 commit comments

Comments
 (0)