Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Updated the README to be clearer.

  • Loading branch information...
commit 61260fbb00a1ec0f89cde04f4a19d9e5910e4e75 1 parent b5a5fc4
Andrew De Ponte authored February 01, 2012
2  Default.sublime-commands
@@ -7,5 +7,5 @@
7 7
   { "caption": "Guard: Output Help", "command": "output_help_guard" },
8 8
   { "caption": "Guard: Reload Guard", "command": "run_all_tests_guard" },
9 9
   { "caption": "Guard: Toggle Notifications", "command": "toggle_notifications_guard" },
10  
-  { "caption": "Guard: Pause", "command": "pause_guard" }
  10
+  { "caption": "Guard: Pause/Unpause", "command": "pause_guard" }
11 11
 ]
85  README.markdown
Source Rendered
@@ -2,16 +2,18 @@ Sublime Text 2 Guard Plugin
2 2
 ===========================
3 3
 
4 4
 This project provides integration of Guard into the Sublime Text 2 editor. I wrote this as
5  
-a quick fun project to help improved my daily workflow while deving on numerous projects
  5
+a convenience tool to help improve my daily workflow while deving on numerous projects
6 6
 using BDD and TDD.
7 7
 
8  
-This plugin basically makes it so that you don't have to leave your Sublime Text 2 editor to
9  
-get the benefits that Guard normally provides, see the output of Guard as it runs tests, or
10  
-control Guard as you would normally be able to.
  8
+This plugin provides an interface for controlling Guard and viewing Guards output within the
  9
+Sublime Text 2 editor. Not having to switch between a terminal and an editor to see Red/Green
  10
+states improves workflow drastically.
11 11
 
12  
-This plugin does NOT include any default key bindings. In fact I do not recommend that you
13  
-setup key bindings for this plugin. This plugin simply provides the following commands
14  
-through the commands popup menu (Cmd+Shift+P):
  12
+
  13
+All of the commands are available via the command palette (**super+shift+p**).
  14
+
  15
+When performing some normal operations in Sublime Text 2, like search,  it hides the Guard output.
  16
+Therefore, this plugin provides a default key binding (**super+shift+c**) to show or reshow the Guard output.
15 17
 
16 18
 * Commands available when Guard is NOT running
17 19
 
@@ -20,7 +22,7 @@ through the commands popup menu (Cmd+Shift+P):
20 22
 * Commands available all of the time
21 23
 
22 24
     * Hide Guard Output
23  
-    * Show Guard Output
  25
+    * Show Guard Output (**super+shift+c**)
24 26
 
25 27
 * Commands available when Guard IS running
26 28
 
@@ -28,53 +30,86 @@ through the commands popup menu (Cmd+Shift+P):
28 30
     * Run all Tests
29 31
     * Reload Guard
30 32
     * Toggle Notifications
31  
-    * Pause
  33
+    * Pause/Unpause
32 34
     * Output Help
33 35
 
34 36
 ## Installation
35 37
 
36  
-Installing this Sublime Text 2 plugin follows the same process you would use to install any other Sublime Text 2 plugin. Simply run the following commands:
  38
+To install this Sublime Text 2 plugin, simply run the following commands:
37 39
 
38 40
     cd ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/
39 41
     git clone git://github.com/cyphactor/sublime_guard.git Guard
40 42
 
41 43
 ## Upgrade
42 44
 
43  
-If you have already installed this plugin to upgrade to the latest version you should simply have to run the following commands:
  45
+To upgrade to the latest version, simply run the following commands:
44 46
 
45 47
     cd ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/Guard
46 48
     git pull
47 49
 
48 50
 ## Usage
49 51
 
50  
-### Commands Popup Menu
  52
+### Command Palette
51 53
 
52  
-As mentioned above the standard way of using this plugin is via the commands popup menu (**Cmd+Shift+P**).
53  
-Once the commands popup menu is up and you fuzzy match the command you want to run simply select it or
54  
-press the return key with it highlighted.
  54
+As mentioned above the primary way of using this plugin is via the command palette (**super+shift+p**).
  55
+Once the command palette is up, fuzzy match the intendend command, and press the return key.
55 56
 
56 57
 ### Starting Guard
57 58
 
58  
-If Guard is not currently running you probably want to "Start Guard" first. When you run the "Start Guard"
59  
-command it will bring up a pane at the bottom of the screen and show you the output of Guard as it runs.
  59
+If Guard is not currently running, start Guard using the "Start Guard" command. It will bring up a pane at
  60
+the bottom of the screen and show the output of Guard as it runs.
60 61
 
61 62
 ### Show/Hide Guard Output
62 63
 
63  
-You can Hide and Show this output pane at any time using the "Hide Guard Output" and "Show Guard Output"
64  
-commands.
  64
+The Guard output can be shown and hidden using the "Show Guard Output" and "Hide Guard Output" command respectively.
  65
+The "Show Guard Output" command is also available via the default key binding (**super+shift+c**).
65 66
 
66 67
 ### Other Useful Commands
67 68
 
68  
-Beyond the above the "Run all Tests", "Reload Guard", and "Pause" commands are a few of my favorite. The
  69
+A few of my favorites commands are "Run all Tests", "Reload Guard", and "Pause/Unpause". The
69 70
 "Run all Tests" command will simply request that Guard run all of the tests. The "Reload Guard" command
70  
-is useful if you have changed some Rails config initializers or something that requires reloading. The
71  
-"Pause" command is primarily useful when you are going checkout a different branch, rebase, etc. It will
72  
-prevent Guard from running all kinds of tests as things are in the process of changing.
  71
+is useful if changes have been made to Rails config initializers or something else that requires reloading. The
  72
+"Pause/Unpause" command is primarily useful when switching branches or rebasing. It will
  73
+temporarily prevent Guard from monitoring the project files for changes.
  74
+
  75
+## RVM Support
  76
+
  77
+This plugin supports RVM out of the box. Basically, it means that it first checks to see if RVM is installed and loads it.
  78
+Once RVM is loaded it then looks to see if any of the top level folders in Sublime Text 2 contain a project specific .rvmrc. If one does it will
  79
+load that .rvmrc and attempt to run Guard on that project.
  80
+
  81
+In the case where it can't find RVM it simply tries to run Guard assuming it is installed as a system gem.
  82
+
  83
+## FAQs
  84
+
  85
+#### Does the Guard process die/exit when Sublime Text 2 dies/exits?
  86
+
  87
+Yes.
  88
+
  89
+#### Why would I get "Failed to find Guardfile and Gemfile in any of the open folders." as an error?
  90
+
  91
+This error message is a result of the project currently loaded in Sublime Text 2 missing either the Guardfile, the Gemfile, or both.
  92
+Currently, this plugin requires a Guardfile and a Gemfile to be present in the projects root path to run Guard.
  93
+
  94
+#### Where do I find out about Guardfiles?
  95
+
  96
+The best place to find out about Guardfiles is the [Guard project page](http://github.com/guard/guard).
  97
+
  98
+#### Where do I found out about Gemfiles?
  99
+
  100
+The best place to find out about Gemfiles is the [Bundler project](http://gembundler.com/).
  101
+
  102
+#### What do I do if I find a bug?
  103
+
  104
+Please report all bugs/issues via the [Issues](http://github.com/cyphactor/sublime_guard/issues) tab.
  105
+
  106
+#### What do I do if I have an idea for a feature/change?
  107
+
  108
+All feature requests or change requests should be made via the [Issues](http://github.com/cyphactor/sublime_guard/issues) tab.
73 109
 
74 110
 ## Contributions
75 111
 
76  
-As with all of my Open Source Projects I am open to contributions. There are numerous ways one can contribute
77  
-below is are just a few.
  112
+As with all of my Open Source Projects I am open to contributions. There are numerous ways one can contribute.
78 113
 
79 114
 1. **Contribute Code/Documentation** - If you would like to contribute code or documentation changes please fork the repository and submit a pull request.
80 115
 2. **Feature Requests/Bug Reports** - If you would like to contribute by submitting either a feature request or a bug report you may do so via the [Issues](http://github.com/cyphactor/sublime_guard/issues) tab.

0 notes on commit 61260fb

Please sign in to comment.
Something went wrong with that request. Please try again.