← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to README

  • Committer: Martin Pool
  • Date: 2005-09-07 04:00:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050907040020-2c7a5e0176888d95
- BROKEN: partial support for commit into weave

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
 
=================
2
 
README for Bazaar
3
 
=================
4
 
 
5
 
Bazaar is a decentralized revision control system, designed to be easy
6
 
for developers and end users alike.
7
 
 
8
 
To install Bazaar from source, follow the instructions in the INSTALL
9
 
file. Otherwise, you may want to check your distribution package manager
10
 
for ready-to-install packages, or http://bazaar-vcs.org/DistroDownloads.
11
 
 
12
 
To learn how to use Bazaar, check the documentation in the doc/ directory.
13
 
Once installed, you can also run 'bzr help'. An always up-to-date and more
14
 
complete set of documents can be found in the Bazaar website, at:
15
 
 
16
 
    http://bazaar-vcs.org/Documentation
17
 
 
18
 
Bazaar is written in Python, and is sponsored by Canonical Limited, the
19
 
founders of Ubuntu and Launchpad. Bazaar is Free Software, and is released
20
 
under the GNU General Public License.
21
 
 
22
 
Bazaar was formerly known as Bazaar-NG, and some documentation still uses
23
 
that old name. Also, since the Bazaar binary is called "bzr", many times this
24
 
shorter name is used instead (like Subversion/svn and Mercurial/hg).
25
 
 
26
 
Bazaar highlights
27
 
=================
28
 
 
29
 
  * Easy to use and intuitive.
30
 
 
31
 
    Only five commands are needed to do all basic operations, and all
32
 
    commands have documentation accessible via 'bzr help command'.
33
 
    Bazaar's interface is also easy to learn for CVS and Subversion users.
34
 
 
35
 
  * Robust and reliable.
36
 
 
37
 
    Bazaar is developed under an extensive test suite. Branches can be
38
 
    checked and verified for integrity at any time, and revisions can be
39
 
    signed with PGP/GnuPG.
40
 
 
41
 
 * Publish branches with HTTP.
42
 
 
43
 
   Branches can be hosted on an HTTP server with no need for special
44
 
   software on the server side. Branches can be uploaded by bzr itself
45
 
   over SSH (SFTP), or with rsync.
46
 
 
47
 
 * Adapts to multiple environments.
48
 
 
49
 
   Bazaar runs on Linux and Windows, fully supports Unicode filenames,
50
 
   and suits different development models, including centralized.
51
 
 
52
 
 * Easily extended and customized.
53
 
 
54
 
   A rich Python interface is provided for extending and embedding,
55
 
   including a plugin interface. There are already many available plugins,
56
 
   most of them registered at http://bazaar-vcs.org/PluginRegistry.
57
 
 
58
 
 * Smart merging.
59
 
 
60
 
    Changes will never be merged more than once, conflicts will be
61
 
    minimized, and identical changes are dealt with well.
62
 
 
63
 
 * Vibrant and active community.
64
 
 
65
 
   Help with Bazaar is obtained easily, via the mailing list, or the IRC
66
 
   channel. Check http://bazaar-vcs.org/BzrSupport for details.
 
1
*********************************
 
2
Release notes for Bazaar-NG 0.0.5
 
3
*********************************
 
4
 
 
5
mbp@sourcefrog.net, May 2005, Canberra
 
6
 
 
7
 
 
8
 
 
9
Caveats
 
10
-------
 
11
 
 
12
 
 
13
 
 
14
* Don't use this for critical data; at the very least keep separate
 
15
  regular snapshots of your tree.
 
16
 
 
17
 
 
18
Dependencies
 
19
------------
 
20
 
 
21
This is mostly developed on Linux (Ubuntu); it should work on Unix,
 
22
Windows, or OS X with relatively little trouble.
 
23
 
 
24
The only dependency is Python 2.4.
 
25
 
 
26
You may optionally install cElementTree to speed up some operations.
 
27
This is strongly recommended if you are dealing with large trees.
 
28
 
 
29
This package includes copies of two Python libraries, elementtree and
 
30
urlgrabber.
 
31
 
 
32
If you are building .deb or .rpm packages for bzr, please don't
 
33
include these libraries but instead package them separately and depend
 
34
on that.
 
35
 
 
36
 
 
37
Installation
 
38
------------
 
39
 
 
40
The best way to install bzr is to symlink the ``bzr`` command onto a
 
41
directory on your path.  For example::
 
42
 
 
43
  ln -s ~/work/bzr/bzr ~/bin/bzr
 
44
 
 
45
If you use a symlink for this, Python will be able to automatically
 
46
find the bzr libraries.  Otherwise you must ensure they are listed on
 
47
your $PYTHONPATH.
 
48
 
 
49
After installing, please run the test suite to identify any problems
 
50
on your platform::
 
51
 
 
52
  ./bzr selftest
 
53
 
 
54
If you use the setup.py script then bzr will be installed into the
 
55
specified path.  In this case you must install ElementTree and
 
56
urlgrabber separately.
 
57