Steve Losh avatar Steve Losh committed 1e8a15e

docs: Create the sparsest README file ever.

Comments (0)

Files changed (1)

+Gorilla
+=======
+
+Gorilla is not even close to alpha-quality yet. But if you want to hack on it,
+feel free!
+
+Get It
+------
+
+    hg clone http://bitbucket.org/sjl/gorilla gorilla
+    hg clone http://bitbucket.org/sjl/gorilla-catalog gorilla/catalog
+
+Install It
+----------
+
+Add the following to your `~/.bashrc` file:
+
+    export PATH="[/path/to]/gorilla/bin:$PATH"
+    export PYTHONPATH="[path/to]/gorilla/lib:$PYTHONPATH"
+
+Replace `[path/to]` with wherever you cloned the Gorilla repository.
+
+Try It
+------
+
+Open a new terminal window, or hit `source ~/.bashrc` and use `gorilla help`
+to see what you can do.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.