Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add a simple readme.

  • Loading branch information...
commit 5285eae7a028c64665a4f7fa529d1cbe547fcc1d 1 parent 82678cb
@sjl sjl authored
Showing with 36 additions and 0 deletions.
  1. +36 −0 README.markdown
View
36 README.markdown
@@ -0,0 +1,36 @@
+Gundo.vim is Vim plugin to visualize your Vim undo tree.
+
+Current status: Alpha. It will probably eat your data. Be careful.
+==================================================================
+
+
+Requirements
+------------
+
+* Vim 7.3+
+* Python support for Vim.
+
+Installation
+------------
+
+Use [Pathogen][]. Don't use pathogen? Start.
+
+Add a mapping to your `~/.vimrc` (change the key to suit your taste):
+
+ nnoremap <F5> :GundoToggle<CR>
+
+[Pathogen]: http://www.vim.org/scripts/script.php?script_id=2332
+
+Usage
+-----
+
+When you're editing a file you can bring up the undo graph with `<F5>` (or
+whatever key you mapped it to).
+
+Press `<F5>` again to close the undo tree and return to your file.
+
+Use `j` and `k` to move up and down the tree. The preview pane will update with
+a diff of the change made by the undo state you're currently on.
+
+Press return to revert the file's contents to that undo state and return to the
+file.
Please sign in to comment.
Something went wrong with that request. Please try again.