UI and readme improvements

Author: leonid-shevtsov

Default.sublime-commands

@@ -2,5 +2,19 @@
   {
     "caption": "Search In Project",
     "command": "search_in_project"
+  },
+  {
+    "caption": "Preferences: Search in Project Settings – Default",
+    "command": "open_file", "args":
+    {
+      "file": "${packages}/Search in Project/SearchInProject.sublime-settings"
+    }
+  },
+  {
+    "caption": "Preferences: Search in Project Settings – User",
+    "command": "open_file", "args":
+    {
+      "file": "${packages}/User/SearchInProject.sublime-settings"
+    }
   }
 ]

README.md

@@ -2,36 +2,46 @@
 
 ![Search in Project screencast](https://raw.githubusercontent.com/leonid-shevtsov/SearchInProject_SublimeText/screencast/screencast.gif)
 
-This plugin for [Sublime Text 2 and 3](http://www.sublimetext.com/) lets you use your favorite search tool (`grep`, `ack`, `ag`, `git grep`, or `findstr`) to find strings aross your entire current Sublime Text project.
+This plugin for [Sublime Text 2 and 3](http://www.sublimetext.com/) lets you use your favorite search tool (`grep`, `ack`, `ag`, `pt`, `git grep`, or `findstr`) to find strings aross your entire current Sublime Text project.
 
 It opens a quick selection panel to browse results, and highlights matches inside files.
 
-It's easy to add another search tool, if you so desire.
+## Usage
+
+* Use the key binding (`⌘⌥⇧F` on OS X, `Ctrl+Alt+Shift+F` on Windows and Linux), or
+* Call the "Search in Project" command;
+* Enter the search query;
+* Hit `Enter` (`Return`). You'll be presented with a "quick select" panel with the search results. Select any file from that panel (it supports fuzzy searching) to go to the match. The search string will be highlighted with an outline and a circle symbol in the gutter area.
+* The last item on the quick select panel is "List results in view". Pick it to see results in a regular editor view. (Tip: if you enter three ticks ("`") in the search box - it's going to be to be the first item.)
+
+If you select text and then run Search In Project, it will pre-fill the search string with the selection text; for example, to search for a word project-wide, do `⌘D, ⌘⌥⇧F, ↩`
+
+If you run Search In Project again, it will remember the last search string, so the next search is just an `↩` away.
 
 **Important note for Windows users: the current release has known issues with running executables, I'd appreciate any bug reports from the field.**
 
 ## Installation
 
-* [Package Control](http://sublime.wbond.net): install package **Search in Project** (this is the recommended method)
+[Package Control](http://sublime.wbond.net): install package **Search in Project** (this is the recommended method)
 
-* Download an [archive of the repository](https://github.com/leonid-shevtsov/SearchInProject_SublimeText/archive/master.zip), and unzip into the Sublime Text Packages folder.
+Manual installation: download an [archive of the repository](https://github.com/leonid-shevtsov/SearchInProject_SublimeText/archive/master.zip), and unzip into the Sublime Text Packages folder.
 
 ### Installing search engines
 
 My idea is that if you use this plugin it's because you already use one of the superior search engines like [The Silver Searcher](https://github.com/ggreer/the_silver_searcher) and want to use it from within Sublime Text.
 
-## Usage
+The supported search engines are:
 
-* Use the key binding (`⌘⌥⇧F` on OS X, `Ctrl+Alt+Shift+F` on Windows), or
-* Call the "Search in Project" command;
-* Enter the search query;
-* Hit `Enter` (`Return`). You'll be presented with a "quick select" panel with the search results. Select any file from that panel (it supports fuzzy searching) to go to the match. The search string will be highlighted with an outline and a circle symbol in the gutter area.
-* The last item on the quick select panel is "List results in view". Pick it to see results in a regular editor view. (Tip: if you enter three ticks ("`") in the search box - it's going to be to be the first item.)
+| Name | Description | Search in Project key
+| - | - | - |
+**[pt (The Platinum Searcher)](https://github.com/monochromegane/the_platinum_searcher)** | **fast, has binaries for every platform, recommended.** | `the_platinum_searcher`
+**[ag (The Silver Searcher)](http://geoff.greer.fm/ag/)** | **equally fast, only 3rd party binaries for Windows, also recommended** | `the_silver_searcher`
+[ack](http://beyondgrep.com/) | not as fast as `pt` and `ag`, but still pretty good. Depends on perl, thus not so easy to install on Windows. | `ack`
+[git grep](http://git-scm.com/docs/git-grep) | packaged with Git and really fast, but only works in Git repositories. Recommended if you use Windows and Git and really don't want to install anything else. | `git_grep`
+[grep](https://en.wikipedia.org/wiki/Grep) | fallback search tool available on Linux and OSX systems. Not recommended - just use the built-in Sublime Text search instead. | `grep`
+[findstr](https://technet.microsoft.com/en-us/library/Bb490907.aspx) | fallback search tool available on Windows. Not recommended - just use the built-in Sublime Text search instead. | `find_str`
 
-
-If you select text and then run Search In Project, it will pre-fill the search string with the selection text; for example, to search for a word project-wide, do `⌘D, ⌘⌥⇧F, ↩`
-
-If you run Search In Project again, it will remember the last search string, so the next search is just an `↩` away.
+**You need to choose the engine you want to use in the configuration file. The default is the one available on every system, but easily the worst.**
 
 ## Configuration
 

install.txt

@@ -0,0 +1,20 @@
+Thanks for installing Search in Project!
+----------------------------------------
+
+Please make sure you open the configuration file ( `Preferences - Search in Project Settings - User` in the Command Palette) and configure the engine you want to use:
+
+    {
+      "search_in_project_engine": "<your_search_engine>"
+    }
+
+where <your_search_engine> is one of:
+
+  the_platinum_searcher, the_silver_searcher, ack, grep, git_grep, grep, or find_str
+
+depending on your preference.
+
+* * *
+
+You can find detailed instructions in the readme at
+
+https://github.com/leonid-shevtsov/SearchInProject_SublimeText#search-in-project

messages.json

@@ -0,0 +1,3 @@
+{
+  "install": "install.txt"
+}