From f7384bbe89690b12a9b6a1ce1cc86e43aa98f5c8 Mon Sep 17 00:00:00 2001 From: guillermooo Date: Thu, 9 Oct 2014 19:57:19 +0200 Subject: [PATCH] edit readme --- README.md | 46 +++++++++++++++++++++++++++++++++------------- 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0f7a878..8be2128 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file