diff README.txt @ 51:d3ae32b7f282

README: misc updates
author Greg Ward <greg-hg@gerg.ca>
date Fri, 10 Jul 2009 14:12:30 -0400
parents 233040cea97a
children a1558739bd5e
line wrap: on
line diff
--- a/README.txt	Fri Jul 10 14:07:30 2009 -0400
+++ b/README.txt	Fri Jul 10 14:12:30 2009 -0400
@@ -10,37 +10,42 @@
 entire history of a version control repository.
 
 This file format was designed to make it easier to write tools which
-converted from foreign VCS repository formats into Git format; such
-tools exist for CVS, Mercurial, Darcs, and Perforce.  
+convert from foreign (non-Git) VCS repository formats into Git; such
+tools exist for CVS, Mercurial, Darcs, and Perforce.
 
 However, there's no reason Git should be the only VCS to read
 git-fast-import files; for example, Bazaar has a fastimport extension
 similar in scope and aim to hg-fastimport.  (In fact, hg-fastimport
 draws heavily on the work done for bzr-fastimport.)
 
-If this tool can become an equally effective reader of such files for
-Mercurial, fast-import can become a "lingua franca" for the exchange of
-repository histories between revision control tools.
+The goal of hg-fastimport is to make it just as easy to populate a
+Mercurial repository from a fastimport dump as it is for Bazaar or Git.
 
 
 DEPENDENCIES
 ------------
 
+hg-fastimport requires Mercurial 1.3.
+
 hg-fastimport depends on the pyfastimport library (which was extracted
 from bzr-fastimport).  pyfastimport lives on launchpad.net at
 
   https://code.launchpad.net/~gward/bzr-fastimport/reusable
 
-If you have Bazaar on your local machine, you can get the code with
+Alternately, I maintain a Mercurial mirror of pyfastimport, so you can
+just use Mercurial to get the code:
 
-  bzr branch lp:~gward/bzr-fastimport/reusable pyfastimport
+  hg clone http://vc.gerg.ca/hg/pyfastimport/
 
-(If you know how to get a tarball out of launchpad.net, please let me
-know.  I don't see how to get the pyfastimport code without Bazaar.)
+To make the 'fastimport' package provided by pyfastimport available
+to hg-fastimport, you need to add the pyfastimport directory to
+PYTHONPATH, e.g.
 
-Then make pyfastimport/fastimport available to hg-fastimport, e.g.
+  PYTHONPATH=$HOME/src/pyfastimport
 
-  ln -s ../pyfastimport/fastimport .
+(Yes, this should get simpler in future: right now, both pyfastimport
+and hg-fastimport are under active development, so things are a bit
+messy.  Bear with me.)
 
 
 USAGE
@@ -50,7 +55,8 @@
 
   fastimport = /path/to/hg-fastimport/hgfastimport
 
-to the [extensions] section of your hgrc.
+to the [extensions] section of your hgrc.  Don't forget to set
+PYTHONPATH as explained above.
 
 To import into a brand-new Mercurial repository:
 
@@ -68,7 +74,7 @@
 of Mercurial "crew" in ~/src/hg-crew.  To test hg-fastimport:
 
   cd tests
-  ~/src/hg-crew/tests/run-tests.py --with-hg=dummy
+  ~/src/hg-crew/tests/run-tests.py --local
 
 
 FURTHER READING
@@ -132,5 +138,3 @@
 You should have received a copy of the GNU General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
-