10dafbce66ff — sietse.brouwer tip 7 years ago
README: add Compatibility, improve Installing
1 files changed, 44 insertions(+), 7 deletions(-)

M README.md
M README.md +44 -7
@@ 129,20 129,57 @@ pull Git branches down and set them up a
 Installing
 ==========
 
-Clone this repository somewhere and make the 'extensions' section in
-your `~/.hgrc` file look something like this:
+As an end-user, you can install Hg-Git from pip.
+
+    sudo pip install hggit
+
+And activate it in your `~/.hgrc` file like so:
+
+    [extensions]
+    hggit =
+
+If you have an older version of Mercurial, read the Compatibility
+section below to see how to install the version of Hg-Git you need.
+
+For development, or if you do not have pip available, clone this
+repository somewhere and make the 'extensions' section in your `~/.hgrc`
+file look something like this:
 
     [extensions]
     hggit = [path-to]/hg-git/hggit
 
 That will enable the Hg-Git extension for you.
 
-This plugin is currently tested against the following Mercurial versions:
+Compatibility
+=============
+
+Each release of Hg-Git is tested against several Mercurial versions. You
+can find a version compatible with your release of Mercurial in the
+table below. To install a specific version of Hg-Git, run the following
+on Linux:
+
+    sudo pip install hggit==0.5.0
+    # useful if you are still on Mercurial 2.2.3
+
+Here is the compatibility table.
 
- * 2.0.2
- * 2.1.2
- * 2.2.3
- * 2.3.1
+    hggit  known-compatible Mercurial versions
+    -----  -----------------------------------
+    0.8.1  2.8.2, 3.0.1, 3.1, 3.2.2, 3.3, 3.4
+    0.8.0  2.8.2, 3.0.1, 3.1, 3.2.2
+    0.7.0  2.8.2, 3.0.1, 3.1
+    0.6.1  2.8.2, 3.0.1
+    0.6.0  2.8.2
+    0.5.0  1.9.3, 2.0.2, 2.1.2, 2.2.3
+    0.4.0  1.9.3, 2.0.2, 2.1.2, 2.2.3
+    0.3.4  1.7.5, 1.8.4, 1.9.3, 2.0.2
+    0.3.3  1.5.4, 1.6.4, 1.7.5, 1.8.4
+    0.3.2  1.4.3, 1.5.4, 1.6.2, 1.7.2
+    0.3.1  1.4.3, 1.5.4, 1.6.2, 1.7.2
+    0.3.0  1.4.3, 1.5.4, 1.6.2, 1.7.2
+    0.2.6  1.4.3, 1.5.4, 1.6.2, 1.7.2
+    0.2.5  1.4.3, 1.5.4, 1.6.2
+    0.2.4  1.4.3, 1.5.4, 1.6.2
 
 Configuration
 =============