Print sane error when a fastimport file is incomplete.
[bzr-fastimport.git] / README.txt
blobcc42afd1f244550dcf96dabe77283b0c7ecb2d27
1 bzr-fastimport: Backend for fast Bazaar data importers
2 ======================================================
4 Dependencies
5 ------------
7 Required and recommended packages are:
9 * Python 2.4 or later
11 * Python-Fastimport 0.9.0 or later.
13 * Bazaar 1.18 or later.
16 Installation
17 ------------
19 The easiest way to install this plugin is to either copy or symlink the
20 directory into your ~/.bazaar/plugins directory. Be sure to rename the
21 directory to fastimport (instead of bzr-fastimport).
23 See http://bazaar-vcs.org/UsingPlugins for other options such as
24 using the BZR_PLUGIN_PATH environment variable.
27 Testing
28 -------
30 To test the plugin after installation:
32     bzr selftest fastimport
35 Documentation
36 -------------
38 To view the documentation after installation:
40     bzr help fastimport
42 Exporters/Importers
43 -------------------
45 There are also fast importers / fast exporters available for other version
46 control tools.
48  * Git: fastimport support is built-in ("git fast-import" / "git fast-export")
49  * Mercurial: http://mercurial.selenic.com/wiki/FastImportExtension
50  * Subversion: http://repo.or.cz/w/fast-export.git
51  * CVS: http://cvs2svn.tigris.org/cvs2bzr.html
52  * Perforce: https://github.com/git/git/blob/master/contrib/fast-import/git-p4
54 Licensing
55 ---------
57 For copyright and licensing details of the exporters, see the relevant
58 files in the exporters/ directory.
60 Otherwise this plugin is (C) Copyright Canonical Limited 2008 under the
61 GPL Version 2 or later. Please see the file COPYING.txt for the licence
62 details.