Skip to content

Commit 88980f5

Browse files
committed
Make 'Installation' section self-contained
* Dulwich requires a C compiler at installation time; this is now mentioned in "Installation" instead of further down in "Dependencies". This leaves "Dependencies" naming the runtime dependencies, and only those. * "Installation" now mentions where to get easy_install/setuptools, for those that don't have it. * "Installation" now explains the difference/advantage of manual install: that one runs Hg-Git from a repository clone rather than from a static package. * "Dependencies" now mentions what Dulwich *is*, for the curious.
1 parent 03ddde9 commit 88980f5

File tree

1 file changed

+41
-27
lines changed

1 file changed

+41
-27
lines changed

index.html

Lines changed: 41 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -94,27 +94,50 @@ <h1 class="tbar"><small>the</small> Hg-Git <small>mercurial plugin</small></h1>
9494

9595
<div class='section'>
9696
<div class="title">Installing</div>
97-
<h3>The easy way:</h3>
97+
<h3>Installing Hg-Git the easy way:</h3>
9898
<p>
99-
Run <code>easy_install hg-git</code>, then add make sure the
99+
First, make sure that you have a working C compiler on your
100+
system. On Windows, one option is the
101+
free <a href="http://www.microsoft.com/express/Downloads/#2008-Visual-CPP">Microsoft
102+
Visual C++</a>. (Be sure to install the 2008 version for
103+
compatibility reasons.) On Debian-style Linux,
104+
run <code>apt-get install python-dev</code>.
105+
</p>
106+
<p>
107+
Secondly, run <code>easy_install hg-git</code>. If you don't
108+
have easy_install available, you can get it as part of
109+
Python's
110+
<a href="http://pypi.python.org/pypi/setuptools">setuptools</a>
111+
package.
112+
</p>
113+
114+
<p>
115+
Lastly, make sure the
100116
following is in your <code>~/.hgrc</code>:
101117
</p>
102118
<pre>[extensions]
103119
hgext.bookmarks =
104120
hggit = </pre>
105121
<p>
106-
...and that's it! Note that this requires having working C
107-
compilers on your system.
122+
...and that's it!
108123
</p>
109124

110-
<h3>The more involved way</h3>
125+
<h3>Installing Hg-Git manually</h3>
111126
<p>
112-
First, install version 0.8.0 or newer
113-
of <a href="http://pypi.python.org/pypi/dulwich">dulwich</a>. You
114-
can do <code>easy_install 'dulwich>=0.8.0'</code> if you
115-
have setuptools
116-
installed. Clone <a href="http://bitbucket.org/durin42/hg-git">this
117-
repository</a> somewhere, then make the 'extensions' section in your
127+
Use this method if you'd like to install a clone of the Hg-Git
128+
repository rather than a static package, or if you'd like to
129+
install Hg-Git in a location you choose yourself.
130+
</p>
131+
<p>
132+
First, install version 0.8.0 or newer of
133+
<a href="http://pypi.python.org/pypi/dulwich">Dulwich</a>.
134+
You can do
135+
<code>easy_install 'dulwich>=0.8.0'</code> if you have
136+
<a href="http://pypi.python.org/pypi/setuptools">setuptools</a>
137+
installed. Next, clone
138+
<a href="http://bitbucket.org/durin42/hg-git">the Hg-Git
139+
repository</a>
140+
somewhere. Lastly, make the 'extensions' section in your
118141
'<code>~/.hgrc</code>' file look something like this:
119142
</p>
120143

@@ -132,22 +155,13 @@ <h3>The more involved way</h3>
132155
<div class='section'>
133156
<div class="title">Dependencies</div>
134157
<p>
135-
This plugin is implemented entirely in Python - there
136-
are <strong>no Git binary dependencies</strong>, you do not
137-
need to have Git installed on your system. There are in fact
138-
no external dependencies currently other than Mercurial and
139-
Dulwich. The plugin is known to work on Mercurial 1.7, and
140-
is basically functional (with a couple of bugs) against hg
141-
1.8 and 1.9.
142-
</p>
143-
<p>
144-
Note that Dulwich has C extensions, so it requires a C
145-
compiler when installing via easy_install. On Windows, one
146-
option is the
147-
free <a href="http://www.microsoft.com/express/Downloads/#2008-Visual-CPP">Microsoft
148-
Visual C++</a>. Be sure to install the 2008 version for
149-
compatibility reasons. On debian-style linux,
150-
run: <code>apt-get install python-dev.</code>
158+
This plugin is known to work on Mercurial 1.7, and is
159+
basically functional (with a couple of bugs) against hg 1.8
160+
and 1.9. It also needs Dulwich version 0.8.0 or later; Dulwich
161+
is a pure-Python implementation of the Git file formats and
162+
protocols. There are <strong>no Git binary
163+
dependencies</strong>: you do not need to have Git installed
164+
on your system.
151165
</p>
152166
</div>
153167

0 commit comments

Comments
 (0)