Permalink
Browse files

List commands in the README file.

  • Loading branch information...
georgebrock committed Dec 7, 2012
1 parent f96b6ce commit 48716188af4e97bfd24494f8976e49709fcbaeb3
Showing with 62 additions and 1 deletion.
  1. +62 −1 README.md
View
@@ -1,6 +1,67 @@
# Vimulator
-Vimulator is a Vim simulator for teaching and demonstrating Vim.
+Vimulator is a Vim simulator for teaching and demonstrating Vim. It has a
+subset of normal mode commands, and an insert mode.
+
+## Supported commands
+
+### Motions
+
+* <kbd>h</kbd>: Move left
+* <kbd>j</kbd>: Move down
+* <kbd>k</kbd>: Move up
+* <kbd>l</kbd>: Move right
+* <kbd>0</kbd>: Move to the start of the line (before leading whitespace)
+* <kbd>^</kbd>: Move to the start of the line (after leading whitespace)
+* <kbd>$</kbd>: Move to the end of the line
+* <kbd>w</kbd>: Move to the next word
+* <kbd>W</kbd>: Move to the next WORD
+* <kbd>e</kbd>: Move to the next word ending
+* <kbd>E</kbd>: Move to the next WORD ending
+* <kbd>b</kbd>: Move back to the previous word
+* <kbd>B</kbd>: Move back to the previous WORD
+* <kbd>g</kbd><kbd>g</kbd>: Move to the first line of the file (or a specific line, if a count is given)
+* <kbd>G</kbd>: Move to the last line of the file (or a specific line, if a count is given)
+* <kbd>+</kbd> or <kbd>Return</kbd>: Move to the start of the next line (after leading whitespace)
+* <kbd>-</kbd>: Move to the start of the previous line (after leading whitespace)
+
+### Insertion
+
+* <kbd>a</kbd>: Append text after the cursor
+* <kbd>A</kbd>: Append text at the end of the line
+* <kbd>i</kbd>: Insert text before the cursor
+* <kbd>I</kbd>: Insert text at the start of the line (after leading whitespace)
+* <kbd>g</kbd><kbd>I</kbd>: Insert text at the start of the line (before leading whitespace)
+* <kbd>o</kbd>: Open the next line
+* <kbd>O</kbd>: Open the previous line
+* <kbd>s</kbd>: Substitute characters under the cursor
+* <kbd>S</kbd>: Substitute to the end of the line
+
+### Operators
+
+* <kbd>c</kbd>, <kbd>c</kbd><kbd>c</kbd> and <kbd>C</kbd>: Change text
+* <kbd>d</kbd>, <kbd>d</kbd><kbd>d</kbd> and <kbd>D</kbd>: Delete text
+
+Operators work with all of the motions listed above, and the following text
+objects:
+
+* <kbd>i</kbd><kbd>b</kbd> and <kbd>a</kbd><kbd>b</kbd>: Inside or around parentheses
+
+### Line search
+
+* <kbd>f</kbd>: Find the next occurrence of a chracter
+* <kbd>F</kbd>: Find the previous occurrence of a chracter
+* <kbd>t</kbd>: Find the character before the next occurrence of a character
+* <kbd>T</kbd>: Find the character after the previous ocurrence of a chracter
+* <kbd>;</kbd>: Repeat the last line search
+* <kbd>,</kbd>: Repeat the last line search, reversing the direction
+
+### Edits
+
+* <kbd>r</kbd>: Replace the character under the cursor
+* <kbd>x</kbd>: Delete the character under the cursor
+* <kbd>X</kbd>: Delete the character before the cursor
+* <kbd>.</kbd>: Repeat the last edit
## License

0 comments on commit 4871618

Please sign in to comment.