← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to README

  • Committer: Robert Collins
  • Date: 2005-10-17 23:13:00 UTC
  • mto: This revision was merged to the branch mainline in revision 1462.
  • Revision ID: robertc@robertcollins.net-20051017231300-e1c9e931bcfacd6a
Branch.open_containing now returns a tuple (Branch, relative-path).

This allows direct access to the common case of 'get me this file
from its branch'. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
 
=================
2
 
README for Bazaar
3
 
=================
4
 
 
5
 
Bazaar (``bzr``) is a decentralized revision control system, designed to be
6
 
easy for developers and end users alike.  Bazaar is part of the GNU project to
7
 
develop a complete free operating system.
8
 
 
9
 
To install Bazaar from source, follow the instructions in the INSTALL
10
 
file. Otherwise, you may want to check your distribution package manager
11
 
for ready-to-install packages, or http://bazaar-vcs.org/DistroDownloads.
12
 
 
13
 
To learn how to use Bazaar, check the documentation in the doc/ directory.
14
 
Once installed, you can also run 'bzr help'. An always up-to-date and more
15
 
complete set of documents can be found in the Bazaar website, at:
16
 
 
17
 
    http://bazaar-vcs.org/Documentation
18
 
 
19
 
Bazaar is written in Python, and is sponsored by Canonical Limited, the
20
 
founders of Ubuntu and Launchpad. Bazaar is Free Software, and is released
21
 
under the GNU General Public License.
22
 
 
23
 
Bazaar was formerly known as Bazaar-NG.  It's the successor to ``baz``, a fork
24
 
of GNU arch, but shares no code.  (To upgrade from Baz, use the ``baz-import``
25
 
command in the bzrtools plugin.)
26
 
 
27
 
Bazaar highlights
28
 
=================
29
 
 
30
 
* Easy to use and intuitive.
31
 
 
32
 
  Only five commands are needed to do all basic operations, and all
33
 
  commands have documentation accessible via 'bzr help command'.
34
 
  Bazaar's interface is also easy to learn for CVS and Subversion users.
35
 
 
36
 
* Robust and reliable.
37
 
 
38
 
  Bazaar is developed under an extensive test suite. Branches can be
39
 
  checked and verified for integrity at any time, and revisions can be
40
 
  signed with PGP/GnuPG.
41
 
 
42
 
* Publish branches with HTTP.
43
 
 
44
 
  Branches can be hosted on an HTTP server with no need for special
45
 
  software on the server side. Branches can be uploaded by bzr itself
46
 
  over SSH (SFTP), or with rsync.
47
 
 
48
 
* Adapts to multiple environments.
49
 
 
50
 
  Bazaar runs on Linux and Windows, fully supports Unicode filenames,
51
 
  and suits different development models, including centralized.
52
 
 
53
 
* Easily extended and customized.
54
 
 
55
 
  A rich Python interface is provided for extending and embedding,
56
 
  including a plugin interface. There are already many available plugins,
57
 
  most of them registered at http://bazaar-vcs.org/PluginRegistry.
58
 
 
59
 
* Smart merging.
60
 
 
61
 
  Changes will never be merged more than once, conflicts will be
62
 
  minimized, and identical changes are dealt with well.
63
 
 
64
 
* Vibrant and active community.
65
 
 
66
 
  Help with Bazaar is obtained easily, via the mailing list, or the IRC
67
 
  channel.
68
 
 
69
 
 
70
 
Registration and Feedback
71
 
=========================
72
 
 
73
 
If you encounter any problems with Bazaar, need help understanding it, or would
74
 
like to offer suggestions or feedback, please get in touch with us:
75
 
 
76
 
* Ask a question through our web support interface, at 
77
 
  https://answers.launchpad.net/bzr/
78
 
 
79
 
* Report bugs at https://bugs.edge.launchpad.net/bzr/+filebug
80
 
 
81
 
* Write to us at bazaar@lists.canonical.com 
82
 
  You can join the list at <https://lists.ubuntu.com/mailman/listinfo/bazaar>.
83
 
  You don't need to subscribe to post, but your first post will be held 
84
 
  briefly for manual moderation.
85
 
 
86
 
* Talk to us in irc://irc.ubuntu.com/bzr
87
 
 
88
 
* And see http://bazaar-vcs.org/BzrSupport for more.
89
 
 
90
 
If you would like to help us improve Bazaar by telling us about yourself and
91
 
what we could do better, please register and complete the online survey here:
92
 
http://www.surveymonkey.com/s.aspx?sm=L94RvLswhKdktrxiHWiX3g_3d_3d.  
93
 
Registration is completely optional. 
94
 
 
95
 
Enjoy,
96
 
The Bazaar Team
 
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