# HG changeset patch
# User Steve Losh <steve@stevelosh.com>
# Date 1286641578 14400
# Node ID 53a39950bd63d111bab8d60b6ef58f0e035566c5
# Parent  756a85290a86fc63c09ecf255c1a99d4754f6262
Add a simple readme.

diff -r 756a85290a86 -r 53a39950bd63 README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.markdown	Sat Oct 09 12:26:18 2010 -0400
@@ -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.