Permalink
Browse files

Adding usage / dev details to readme.

  • Loading branch information...
Gozala committed Feb 10, 2011
1 parent b014630 commit 8827de9758817a01d0dd9a8a854e799d4f58a053
Showing with 27 additions and 1 deletion.
  1. +24 −1 README.md
  2. +3 −0 support/.gitignore
View
@@ -1,8 +1,31 @@
# vice #
-Vim mode for ace.
+This is VIM plugin for Ace. It can be added to the list of Ace plugins to add
+a VIM modes and keybindings.
## Install ##
npm install vice
+## Usage ##
+
+ teleport activate
+ open http://localhost:4747/vice
+
+## Develop ##
+
+Easiest way to work on Vice is using `teleport` all you need to do in this case
+is following (see wiki for more [details]):
+
+ git clone git://github.com/Gozala/vice.git
+ npm link vice
+
+If you don't feel comfortable using teleport, you can also use symlinks or
+git submodules / repos instead. All you need is to have is clones of following
+repositories in `./support` directory:
+
+- [ace](https://github.com/ajaxorg/ace)
+- [pilot](https://github.com/ajaxorg/pilot)
+- [cockpit](https://github.com/ajaxorg/cockpit)
+
+[details]:https://github.com/ajaxorg/ace/wiki/Edit-or-embed-Ace-%28with-Teleport%29
View
@@ -0,0 +1,3 @@
+# Everything in this folder is ignored checkout README for details.
+*
+!.gitignore

0 comments on commit 8827de9

Please sign in to comment.