Clean up the README.

This commit is contained in:
Steve Losh 2010-11-10 11:23:42 -05:00
parent 1658b76b10
commit 8f297bffde

View File

@ -21,35 +21,14 @@ Requirements
* Python support for Vim
* Python 2.4+
Installation
------------
Installation and Usage
----------------------
Use [Pathogen][]. Don't use pathogen? Start.
Check out the [project site][] for installation instructions.
hg clone http://bitbucket.org/sjl/gundo.vim ~/.vim/bundle/gundo
[project site]: http://sjl.bitbucket.org/gundo.vim/
There's a git mirror if you prefer:
License
-------
git clone http://github.com/sjl/gundo.vim.git ~/.vim/bundle/gundo
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
-----
Run `:help gundo` for the full docs. Here's the in-a-nutshell version.
When you're editing a file you can bring up the undo graph for that file with
`<F5>` (or whatever key you mapped it to).
Press `<F5>` again to close the undo graph and return to your file.
Use `j` and `k` to move up and down the graph. 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.
GPLv2+, just like Mercurial.