← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to README

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-01-21 10:00:42 UTC
  • mfrom: (4978.1.2 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100121100042-77858a88k2zpec7b
(nmb) Add documentation for multi-parent merges

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
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
 
 
 
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
 
7
to develop a complete free operating system.
 
8
 
 
9
To install Bazaar, follow the instructions given at
 
10
http://bazaar-vcs.org/Download. Ready-to-install packages are available
 
11
for most popular operating systems or you can install from source.
 
12
 
 
13
To learn how to use Bazaar, see the official documentation at:
 
14
 
 
15
    http://doc.bazaar-vcs.org/en/
 
16
 
 
17
For additional training materials including screencasts and slides,
 
18
visit our community wiki documentation page at:
 
19
 
 
20
    http://bazaar-vcs.org/Documentation/
 
21
 
 
22
Bazaar is written in Python, and is sponsored by Canonical Limited, the
 
23
founders of Ubuntu and Launchpad. Bazaar is Free Software, and is released
 
24
under the GNU General Public License.
 
25
 
 
26
Bazaar highlights
 
27
=================
 
28
 
 
29
Bazaar directly supports both central version control (like cvs/svn) and
 
30
distributed version control (like git/hg). Developers can organize their
 
31
workspace in whichever way they want on a per project basis including:
 
32
 
 
33
* checkouts (like svn)
 
34
* feature branches (like hg)
 
35
* shared working tree (like git).
 
36
 
 
37
It also directly supports and encourages a large number of development best
 
38
practices like refactoring and pre-commit regression testing. Users can
 
39
choose between our command line tool and our cross-platform GUI application.
 
40
For further details, see our website at http://bazaar-vcs.org/en.
 
41
 
 
42
Feedback
 
43
========
 
44
 
 
45
If you encounter any problems with Bazaar, need help understanding it, or would
 
46
like to offer suggestions or feedback, please get in touch with us:
 
47
 
 
48
* Ask a question through our web support interface, at 
 
49
  https://answers.launchpad.net/bzr/
 
50
 
 
51
* Report bugs at https://bugs.launchpad.net/bzr/+filebug
 
52
 
 
53
* Write to us at bazaar@lists.canonical.com 
 
54
  You can join the list at <https://lists.ubuntu.com/mailman/listinfo/bazaar>.
 
55
  You don't need to subscribe to post, but your first post will be held 
 
56
  briefly for manual moderation.
 
57
 
 
58
* Talk to us in irc://irc.ubuntu.com/bzr
 
59
 
 
60
Our mission is to make a version control tool that developers LOVE to use
 
61
and that casual contributors feel confident with. Please let us know how
 
62
we're going.
 
63
 
 
64
The Bazaar Team