Skip to content
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

Jump to bottom

Clarifying that this plugin also works for Sublime Text 3 #42

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarifying that this plugin also works for Sublime Text 3 #42

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
24 changes: 18 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
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.

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

Expand All @@ -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
-----------
Expand All @@ -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!*
*Good luck!*