33[ ![ Analytics] ( https://ga-beacon.appspot.com/UA-280328-3/pope/SublimeYetAnotherCodeSearch/README )] ( https://github.com/igrigorik/ga-beacon )
44[ ![ Build Status] ( https://travis-ci.org/pope/SublimeYetAnotherCodeSearch.svg?branch=master )] ( https://travis-ci.org/pope/SublimeYetAnotherCodeSearch )
55
6- This is a plugin for [ Sublime Text] [ ST ] that works with [ CodeSearch] [ CS ] to
6+ This is a plugin for [ Sublime Text 3 ] [ ST ] that works with [ CodeSearch] [ CS ] to
77provide fast searching in a large codebase. This is most useful for large
88projects where a normal Find is just too slow.
99
@@ -22,9 +22,28 @@ anyway. Some things worth highlighting:
2222 - Can specify case and file restrictions when searching
2323 - Manage and update the index file for a Sublime project.
2424
25- ## Installation
25+ ## Setup
2626
27- TODO. (talk about installing csearch AND this plugin)
27+ ### Prerequisite
28+
29+ You will need a [ CodeSearch] [ CS ] binary. You can build this by installing [ Go] [ ]
30+ and get the binary.
31+
32+ go get code.google.com/p/codesearch/cmd/...
33+
34+ ### Installation
35+
36+ The easiest way to install the plugin is to simply use [ PackageControl] [ PC ] .
37+ Just look for the * YetAnotherCodeSearch* plugin and install.
38+
39+ -or-
40+
41+ You could download/clone the source and place it into your Sublime Text plugin
42+ directory with the name * YetAnotherCodeSearch* .
43+
44+ git clone \
45+ https://github.com/pope/SublimeYetAnotherCodeSearch.git \
46+ YetAnotherCodeSearch
2847
2948## Usage
3049
@@ -101,8 +120,18 @@ The location of `codesearchindex` is defined relatively to the project location.
101120
102121## Development
103122
104- TODO. (talk about current development and testing)
123+ Please file an [ issue] [ ] if you would like a new enhancement of if you run into
124+ any bugs. Of course, patches are always welcome :)
125+
126+ ### Testing
127+
128+ In order to run the unit tests, please install randy3k's lovely [ UnitTesting] [ ]
129+ Sublime plugin and run the unit tests via that.
105130
106131[ ST ] : https://www.sublimetext.com/
107132[ CS ] : https://code.google.com/p/codesearch/
108133[ SublimeCodeSearch ] : https://github.com/whoenig/SublimeCodeSearch
134+ [ Go ] : https://golang.org/
135+ [ PC ] : https://sublime.wbond.net/
136+ [ issue ] : https://github.com/pope/SublimeYetAnotherCodeSearch/issues
137+ [ UnitTesting ] : https://github.com/randy3k/UnitTesting
0 commit comments