diff --git a/README.md b/README.md index 7e10fdd..512543e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ SublimeOnSaveBuild Sublime Plugin ================================= -This is a simple plugin for [Sublime Text 2](http://www.sublimetext.com/2) to trigger a build on each save. +This is a simple plugin for [Sublime Text 2 & 3](http://www.sublimetext.com/) to trigger a build on each save. Not all projects might need this plugin, especially if the build operation is lengthy. However, if you have a build that does things like pre-processing CSS via tools like [LessCSS](http://lesscss.org) and stitching all JS files together, this might be very handy. @@ -9,11 +9,11 @@ Installation ------------ **With the Package Control plugin:** The easiest way to install SublimeOnSaveBuild is through Package Control, which can be found at this site: http://wbond.net/sublime_packages/package_control -Once you install Package Control, restart ST2 and bring up the Command Palette (`Command+Shift+P` on OS X, `Control+Shift+P` on Linux/Windows). Select "Package Control: Install Package", wait while Package Control fetches the latest package list, then select SublimeOnSaveBuild when the list appears. The advantage of using this method is that Package Control will automatically keep SublimeOnSaveBuild up to date with the latest version. +Once you install Package Control, restart Sublime Text and bring up the Command Palette (`Command+Shift+P` on OS X, `Control+Shift+P` on Linux/Windows). Select "Package Control: Install Package", wait while Package Control fetches the latest package list, then select SublimeOnSaveBuild when the list appears. The advantage of using this method is that Package Control will automatically keep SublimeOnSaveBuild up to date with the latest version. -**Without Git:** Download the latest source from [GitHub](http://github.com/alexnj/SublimeOnSaveBuild) and copy the SublimeOnSaveBuild folder to your Sublime Text 2 "Packages" directory. +**Without Git:** Download the latest source from [GitHub](http://github.com/alexnj/SublimeOnSaveBuild) and copy the SublimeOnSaveBuild folder to your Sublime Text "Packages" directory. -**With Git:** Clone the repository in your Sublime Text 2 "Packages" directory: +**With Git:** Clone the repository in your Sublime Text "Packages" directory: git clone git://github.com/alexnj/SublimeOnSaveBuild.git @@ -23,14 +23,26 @@ The "Packages" directory is located at: * OS X: ~/Library/Application Support/Sublime Text 2/Packages/ + + OR + + ~/Library/Application Support/Sublime Text 3/Packages/ * Linux: ~/.config/sublime-text-2/Packages/ + + OR + + ~/.config/sublime-text-3/Packages/ * Windows: %APPDATA%/Sublime Text 2/Packages/ + + OR + + %APPDATA%/Sublime Text 3/Packages/ Configuring ----------- @@ -46,7 +58,7 @@ SublimeOnSaveBuild matches the name of the file being saved against this regular Usage ----- -1. Make sure you have a build operation set up in your Sublime Text 2 project and you are able to build using `Control+B` (Linux/Windows) or `Command+B` (OS X). +1. Make sure you have a build operation set up in your Sublime Text project and you are able to build using `Control+B` (Linux/Windows) or `Command+B` (OS X). 2. Hit your favorite shortcut to Saveit should trigger a build. -*Good luck!* \ No newline at end of file +*Good luck!*