Mercurial > hg-git

diff README.md @ 325:ef7a7df7a8a7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
README: document git.intree In 9fa5e81 (Allow storing the git directory intree), hg-git learnt a new configuration option, but this wasn't documented. Address this.
author Tay Ray Chuan <rctay89@gmail.com>
date Mon, 17 May 2010 20:15:50 +0800
parents 3ab3765db5bc
children 7d0cb1938ef9
line wrap: on
line diff
--- a/README.md	Mon May 17 20:04:02 2010 +0800
+++ b/README.md	Mon May 17 20:15:50 2010 +0800
@@ -74,6 +74,20 @@
 
 That will enable the Hg-Git extension for you.  The bookmarks section is not compulsory, but it makes some things a bit nicer for you.
 
+Configuration
+=============
+
+git.intree
+----------
+
+hg-git keeps a git repository clone for reading and updating. By default, the
+git clone is the subdirectory `git` in your local Mercurial repository. If you
+would like this git clone to be at the same level of your Mercurial repository
+instead (named `.git`), add the following to your `hgrc`:
+
+    [git]
+    intree = True
+
 Authors
 ========