Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

added documentation lookup instructions to README

  • Loading branch information...
commit 350fe4f8f76c7e1672c3b994cee27159f87926de 1 parent 3570906
@goonzoid authored
Showing with 18 additions and 0 deletions.
  1. +18 −0 README.md
View
18 README.md
@@ -8,9 +8,27 @@ which was in turn an extension of vim script
## Features
+* Syntax highlighting
+* Documentation lookup
* Run sketches from within vim (experimental and potentially dangerous,
read below for more info)
+### Looking up documentation
+
+This feature requires that your vim has been compliled with python support.
+Simply move the cursor to the keyword you would like to look up and hit 'K' in
+normal mode. Note that words followed by an opening paren '(' are treated as
+functions, so `frameRate()` and `frameRate` will go to different pages in the
+documentation.
+
+By default, reprocessed will try to look up documentation online. However, you
+can configure it to access local documentation by adding the following line to
+your `.vimrc`:
+
+ let processing_doc_path="/path/to/processing/docs/on/your/machine"
+
+Of course, you'll want to replace the path with the actual path on your machine.
+
### Running sketches from within vim
__WARNING:__ If you have a directory inside your sketch directory called `bin`
Please sign in to comment.
Something went wrong with that request. Please try again.