158ad3aea810

Installation.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 13 Jun 2011 12:52:56 -0400
parents 11bf5263576c
children 112752863b5b
branches/tags (none)
files README.markdown

Changes

--- a/README.markdown	Mon Jun 13 09:39:02 2011 -0400
+++ b/README.markdown	Mon Jun 13 12:52:56 2011 -0400
@@ -1,8 +1,8 @@
 This plugin is still under active development.
 ==============================================
 
-It is not even remotely ready yet.
-==================================
+It is not even remotely ready yet.  Lots of things are unimplemented.
+=====================================================================
 
 It will probably eat your data.
 ===============================
@@ -22,6 +22,29 @@
 * Changelog
 * License
 
+Installation
+============
+
+Use Pathogen to install the plugin, then add it as a merge tool for your VCS of
+choice:
+
+**Mercurial:** add the following lines to `~/.hgrc`:
+
+    [merge-tools]
+    threesome.executable = mvim
+    threesome.args = -f -O4 $base $local $other $output -c 'ThreesomeInit'
+    threesome.premerge = keep
+    threesome.priority = 1
+
+**Git:** add the following lines to `~/.gitconfig`:
+
+    [merge]
+    tool = threesome
+
+    [mergetool "threesome"]
+    cmd = "mvim -f $BASE $LOCAL $REMOTE $MERGED -c 'ThreesomeInit'"
+    trustExitCode = true
+
 Basic Usage
 ===========