[PATCH 1 OF 2] Improve Installation section of README

[Sietse Brouwer]

Dear list,

The Hg-Git website [1] currently tells users that if they want to know
which version of Hg-Git works with their Mercurial version, they should
go to Bitbucket, update to each version tag, and inspect the Makefile.
This patch aims to improve that situation.

[1] https://hg-git.github.io/

* The first patch adds an Hg-Git / Mercurial version compatibility
table to the installation section of the README, and removes a
far-out-of-date 'the current version is compatible with ...' list.

* The second patch improves the Installing section to explain
installation from pip as well as from a cloned repo.

If and when the first patch is accepted, I'll submit a PR for the
https://hg-git.github.io/ repo to make the website say 'for version
compatibility, see the README' instead of 'update to each version tag
and read the Makefile'.

Cheers,

Sietse
Sietse Brouwer


# HG changeset patch
# User Sietse Brouwer <sbbr...@gmail.com>
# Date 1433184789 -7200
# Mon Jun 01 20:53:09 2015 +0200
# Node ID dc5c4654815ac4bcd4aa1a2499ed012c70a4ed78
# Parent d153586c28f8e639b17a049ab599917ec8a87331
README: add Hg-Git/Hg version compatibility table

diff --git a/README.md b/README.md
--- a/README.md
+++ b/README.md
@@ -137,12 +137,28 @@

That will enable the Hg-Git extension for you.

-This plugin is currently tested against the following Mercurial versions:
+Hg-Git is tested against the following Mercurial versions:

- * 2.0.2
- * 2.1.2
- * 2.2.3
- * 2.3.1
+ Hg-Git 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
=============

[Siddharth Agarwal]

On 06/01/2015 12:00 PM, Sietse Brouwer wrote:
> Dear list,
>
> The Hg-Git website [1] currently tells users that if they want to know
> which version of Hg-Git works with their Mercurial version, they should
> go to Bitbucket, update to each version tag, and inspect the Makefile.
> This patch aims to improve that situation.

I appreciate what you're trying to do here, but no one's going to
actually make sure that the readme is up to date. We ensure that a
release of hg-git will work on every Mercurial version from whatever
shipped in the last Ubuntu LTS to whatever was latest on the day that
hg-git version was released. I think changing the readme to say that is
the right thing to do here.

- Siddharth

[Sietse Brouwer]

The second patch: add installation via pip to the installation
section. This is the easy way for most *nix-based end users of Hg-Git.

(NB: I've composed this mail replying to the email I just sent, but
I'm not sure whether Gmail preserves the In-reply-to header if I
change the email's subject. Apologies in advance if it hasn't.)

# HG changeset patch
# User Sietse Brouwer <sbbr...@gmail.com>

# Date 1433184810 -7200
# Mon Jun 01 20:53:30 2015 +0200
# Node ID 9db4a2883eaee58d6db7397a7aaabac75119677d
# Parent dc5c4654815ac4bcd4aa1a2499ed012c70a4ed78
README: add pip to installation instructions

diff --git a/README.md b/README.md
--- a/README.md
+++ b/README.md

@@ -129,11 +129,35 @@
Installing
==========

-Clone this repository somewhere and make the 'extensions' section in
-your `~/.hgrc` file look something like this:
+Hg-Git can be installed via pip or from source. You will generally want
+the latest version of Hg-Git; if you have an old version of Mercurial,
+see the compatibiity table at the end of this section.
+
+When using pip, first get Hg-Git:
+
+ sudo pip install hggit
+
+ ## To install a specific version:
+ # sudo pip install hggit==0.5.0
+
+Then activate Hg-Git by adding the following to your `~/.hgrc`:

[extensions]
- hggit = [path-to]/hg-git/hggit
+ hggit =
+
+When installing from source (useful for developing or if you don't
+have pip available), first clone Hg-Git:
+
+ hg clone https://bitbucket.org/durin42/hg-git
+
+ ## To clone and update to a specific version:
+ hg clone https://bitbucket.org/durin42/hg-git --updaterev 0.5.0
+
+Then add the following to your `~/.hgrc`. Because Hg-Git was not
+installed using pip, you must tell Mercurial where to find it:
+
+ [extensions]
+ hggit = .../path/to/hg-git/hggit