Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

* README improvements

  • Loading branch information...
commit 0652f8f0ee9e7f7281e6874e1cbd2ae8cafbaccb 1 parent 3f4118e
@zergu authored
Showing with 32 additions and 4 deletions.
  1. +32 −4 README
View
36 README
@@ -1,8 +1,31 @@
-Plugin creates keyboard shortcuts for editing most common files or exploring most common directories. Currenty works only in Symfony 1.4 projects but I have plans to extend support to Symfony 2 and Rails 3.
+Project-Jumper 0.1
-Shortcuts are working only when current directory is from inside a project.
+What is Project-Jumper?
+-----------------------
-Project shortcuts:
+Project Jumper is a Vim plugin which creates keyboard shortcuts for editing most common files or exploring most common directories. Currenty works only in Symfony 1.4 projects but I have plans to extend support to Symfony 2 and Rails 3.
+
+Latest version
+--------------
+
+Latest version of Vim Project Jumper can be found at https://github.com/zergu/Vim-Project-Jumper
+
+Installation
+------------
+
+Unpack all *.vim files and this README into ~/.vim/plugin/project-jumper/ directory. Restart Vim in necessary.
+
+Usage
+-----
+
+Default shortucts work from Vim edit mode. To invoke a jump keep @ctrl@ presses and then type @j@ and other key depending whare you're trying to jump.
+
+Shortcuts are working only when current directory (you can check it with :pwd command) is from inside a project. Avoid using shortucts elsewhere cause it can do some heavy and unsuccessful file searching.
+
+Default shotcuts
+----------------
+
+Project project related:
* <C-j><C-m> Model: Explore lib/model dir.
* <C-j><C-s> Schema: Edit config/*schema.yml (menu for multiple options).
* <C-j><C-y> CSS: Explore web/css dir.
@@ -15,10 +38,15 @@ Project shortcuts:
* <C-j><C-q> SQL: Explore data/sql dir.
* <C-j><C-x> Fixtures: Explore data/fixtures dir.
-Application shortcuts (if your project has more that one application avaiable options are shown):
+Application replated (if your project has more that one application avaiable options are shown):
* <C-j><C-u> Layout: Edit $appname/templates/*layout*.php file (supports multiple options).
* <C-j><C-o> Modules: Explore $appname/modules dir.
* <C-j><C-r> Routing: Edit $appname/config/routing.yml file.
* <C-j><C-g> AppConfig: Edit $appname/config/app.yml file.
* <C-j><C-a> Action: Edit actions.class.php when editing or exploring module templates.
* <C-j><C-v> View: While cursor is placed on function header tries to edit associaded view. If none could be found, explores views directory.
+
+Remapping shortucts
+-------------------
+
+TODO
Please sign in to comment.
Something went wrong with that request. Please try again.