Add instructions for how to use SublimeLinter settings

saasmath · Nov 5, 2012 · 14088de · 14088de
1 parent c202b0c
commit 14088de
Showing 1 changed file with 11 additions and 6 deletions.
diff --git a/SublimeLinter.sublime-settings b/SublimeLinter.sublime-settings
@@ -1,15 +1,20 @@
 /**
- * Airbnb JSHint for settings for use with SublimeLinter.
+ * Airbnb JSHint for settings for use with SublimeLinter and Sublime Text 2.
  *
- *   Install SublimeLinter at https://github.com/SublimeLinter/SublimeLinter
+ *   1. Install SublimeLinter at https://github.com/SublimeLinter/SublimeLinter
+ *   2. Open user preferences for the SublimeLinter package in Sublime Text 2
+ *     * For Mac OS X go to _Sublime Text 2_ > _Preferences_ > _Package Settings_ > _SublimeLinter_ > _Settings - User_
+ *   3. Paste the contents of this file into your settings file
+ *   4. Save the settings file
  *
- * @see https://github.com/SublimeLinter/SublimeLinter
- * @see http://www.jshint.com/docs/
+ * @version 0.1.0
+ * @see     https://github.com/SublimeLinter/SublimeLinter
+ * @see     http://www.jshint.com/docs/
  */
 {
   "jshint_options":
     {
-      /**
+      /*
        * ENVIRONMENTS
        * =================
        */
@@ -20,7 +25,7 @@
       // Defines globals exposed by jQuery.
       "jquery": true,
 
-      /**
+      /*
        * ENFORCING OPTIONS
        * =================
        */