Skip to content

edit readme #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2014
Merged

edit readme #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 33 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,41 @@ PowerShell

Support for the MS PowerShell programming language.


# Install
1. Install [package control](https://sublime.wbond.net/installation) for Sublime Text.
1. Install package **PowerShell** (`Ctrl + Shift + P` + `install` + `powershell`)

1. Install [package control][package_control] for Sublime Text.
1. Install the **PowerShell** package:

1. `Ctrl + Shift + P`
1. `install`
1. `powershell`


# Development
1. Open sublime packages folder (`Ctrl + Shift + P` + `browse packages`)
1. Clone [this repo](https://github.com/SublimeText/PowerShell) to packages folder.
Now your local version of package is available in sublime.

1. Open the Sublime Text packages folder (`Ctrl + Shift + P` + `browse packages`)
1. Clone [this repo][this_repo] to the packages folder
Now your local version of this package is available in Sublime Text.


## Syntax
Plist file [PowershellSyntax.tmLanguage](Support/PowershellSyntax.tmLanguage) is the master file for syntax.
But the [recommended way](http://sublime-text-unofficial-documentation.readthedocs.org/en/latest/extensibility/syntaxdefs.html) to develop syntax is YAML.

1. Install `AAAPackageDev` package.
1. Open **PowershellSyntax.tmLanguage**
1. Call `Ctrl + Shift + P` + `convert to Yaml and Rearrange`. You will get new file **Support/PowershellSyntax.YAML-tmLanguage**.
1. Make your changes in YAML file.
1. Call `Ctrl + Shift + P` + `convert (YAML, JSON, Plist) to`. You will get updated version of plist file.

The plist file [PowershellSyntax.tmLanguage](Support/PowershellSyntax.tmLanguage)
is the syntax definition's master file.

However, the [recommended way][syntax_topic] to edit the syntax definition
is YAML format. To use this format, follow these steps:

1. Using Package Control, install the `AAAPackageDev` package.
1. Open **PowershellSyntax.tmLanguage**.
1. Call `Ctrl + Shift + P` + `convert to Yaml and Rearrange`.
You will get a new file: **Support/PowershellSyntax.YAML-tmLanguage**.
1. Edit the YAML file.
1. Call `Ctrl + Shift + P` + `convert (YAML, JSON, Plist) to`.
You will get and updated version of the plist file.


[package_control]: https://sublime.wbond.net/installation
[this_repo]: https://github.com/SublimeText/PowerShell
[syntax_topic]: http://sublime-text-unofficial-documentation.readthedocs.org/en/latest/extensibility/syntaxdefs.html