diff README.rst @ 90:f58882dce2d7

Move README.txt to README.rst and tidy up Now reflects no dependencies, how to install using pip and how to use it. All other information has been discarded and can be found by looking in other files.
author Roy Marples <roy@marples.name>
date Tue, 19 Jan 2021 23:05:11 +0000
parents README.txt@a739b8dc8e6f
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Tue Jan 19 23:05:11 2021 +0000
@@ -0,0 +1,57 @@
+=============
+hg-fastimport
+=============
+
+WARNING: this extension is incomplete and lightly tested.  It is
+currently intended for Mercurial developers or particularly daring
+users.
+
+hg-fastimport is a Mercurial extension for importing Git's fast-import
+dumps into Mercurial. fast-import is a file format for representing the
+entire history of a version control repository.
+
+This file format was designed to make it easier to write tools which
+convert from foreign (non-Git) VCS repository formats into Git; such
+tools exist for CVS, Mercurial, Darcs, and Perforce.
+
+==============
+How to Install
+==============
+
+Using Pip
+---------
+
+You can install the latest released version using pip::
+
+  $ pip install --user hg-fastimport
+
+Then enable it in yourn hgrc::
+
+  [extensions]
+  fastimport =
+
+From Source
+-----------
+
+To install a local version from source::
+
+  $ hg clone https://roy.marples.name/hg/hg-fastimport/
+  $ cd hg-fastimport
+  $ pip install --user .
+
+Then enable it in your hgrc::
+
+  [extensions]
+  fastimport =
+
+==========
+How to Use
+==========
+
+To import into a brand-new Mercurial repository::
+
+  $ hg init new
+  $ cd new
+  $ hg fastimport --datesort FILE...
+
+where FILE... is a list of one or more fast-import dumps.