# HG changeset patch # User Steve Losh # Date 1308016819 14400 # Node ID 2f20f9b5393391e0e136062b27300c1e59ec8f13 # Parent dadef6acf2190e8e4dde83eaffefd51dc814353e Markdown. diff -r dadef6acf219 -r 2f20f9b53933 README.markdown --- a/README.markdown Mon Jun 13 21:53:54 2011 -0400 +++ b/README.markdown Mon Jun 13 22:00:19 2011 -0400 @@ -13,6 +13,9 @@ Seriously. If you use it and complain about it eating your data I am going to make fun of you on Twitter. ========================================================================================================= +Threesome +========= + Threesome is a Vim plugin for resolving conflicts during three-way merges. It's designed to be used as a merge tool for version control systems like Mercurial and Git. @@ -24,7 +27,7 @@ * **Full Documentation:** `:help threesome` Requirements -============ +------------ Vim 7.3+ compiled with Python 2.5+ support. @@ -39,7 +42,7 @@ Feels bad, man. Installation -============ +------------ Use Pathogen to install the plugin. @@ -47,9 +50,11 @@ :call pathogen#helptags() -Add it as a merge tool for your VCS of choice: +Add it as a merge tool for your VCS of choice. -**Mercurial:** add the following lines to `~/.hgrc`: +### Mercurial + +Add the following lines to `~/.hgrc`: [merge-tools] threesome.executable = mvim @@ -57,7 +62,9 @@ threesome.premerge = keep threesome.priority = 1 -**Git:** add the following lines to `~/.gitconfig`: +### Git + +Add the following lines to `~/.gitconfig`: [merge] tool = threesome @@ -70,12 +77,12 @@ prefer to keep the editor in the console. More Information -================ +---------------- Read the full documentation to learn more `:help threesome` TODO for v1.0.0 -=============== +--------------- * Add a basic test suite. * Remove the eat-your-data warnings in the docs.