Skip to content
Browse files

first commit

  • Loading branch information...
1 parent 8b440a9 commit db9010cae11325e35324acf05bd6939848fb87f4 @mihaifm committed May 12, 2012
Showing with 102 additions and 54 deletions.
  1. +102 −54 README.md
  2. BIN vim.exe → vim.ahk.exe
View
156 README.md
@@ -1,69 +1,117 @@
-Supported commands:
-===========
-
-Esc
-i
-I
-v
-
-visual mode
- h j k l
- numeric multipliers (except 0)
- >
- <
-
-normal mode
- {motion}
- h j k l
- numeric multipliers
- w //limited: word boundaries
- 0
- ^
- $
+### Description
+
+**Vim.ahk** is a script that attempts to mimic Vim commands inside Windows applications.
+
+The script is experimental and only supports a small subset of Vim commands.
+
+**[Demo](http://www.youtube.com/watch?v=z8sj_t23n_s)**
+
+### Usage
+
+Vim.ahk was created with [Autohotkey_L](http://l.autohotkey.net/).
+
+In order to use it, install [Autohotkey_L](http://l.autohotkey.net/), then run the **vim.ahk** file.
+
+Alternativelly, run **vim.ahk.exe**, which is a compiled version of the script. This does not require [Autohotkey_L](http://l.autohotkey.net/) to be installed.
+
+### Modes
+
+Vim.ahk supports the following modes:
+
+* Suspended
+
+In this mode the script does nothing. To activate the script, press the <kbd>F12</kbd> key.
+This key can be easily changed within the script (just search for F12 and replace it with the key of you choice).
+Other good candidates are: CapsLock, F8 or the ContextMenu key.
+
+* Normal
+* Insert
+* Visual
+
+Regular Vim modes.
+
+By default, the script starts in Suspended mode. It remembers the mode for each individual window, so each window will have it's own mode.
+
+### Supported commands
+
+ Esc
+ i
+ I
+ v
+
+ normal mode
+ {motion}
+ h j k l
+ numeric multipliers
+ w
+ 0
+ ^
+ $
- d{motion}
- dd
- D
-
- y{motion}
- yy //limited: moves cursor
- Y
+ d{motion}
+ dd
+ D
+
+ y{motion}
+ yy
+ Y
+
+ c{motion}
+ cc
+ C
+
+ p
+
+ s
+ S
+
+ a
+ A
- c{motion}
- cc //limited: doesn't preserve indentation
- C
+ b
- p
-
- s
- S
+ e
- a
- A
+ n
+ N
- b
+ o
+ O
+
+ u
+
+ x
+ X
+
+ J
+
+ >>
+
+ <<
+
+ visual mode
+ h j k l
+ numeric multipliers (except 0)
+ >
+ <
- e
+ registers
+ named: a-z, A-Z
+ numbered: 0, 1, 2-9
+ blackhole: _
- n
- N
+### Limitations
- o //limited: no multipliers
- O
+ w - word boundaries
+ yy - moves cursor
+ cc - doesn't preserve indentation
+ o - no multipliers
+ X - deletes beginning of line
+ << - deletes everything, not just indentation
- u
- x
- X //limited: deletes beginning of line
- J //limited: does work with indentation
- >>
- << //limited: deletes everything, not just indentation
-registers
- named: a-z, A-Z
- numbered: 0, 1, 2-9
- blackhole: _
View
BIN vim.exe → vim.ahk.exe
Binary file not shown.

0 comments on commit db9010c

Please sign in to comment.
Something went wrong with that request. Please try again.