← 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-03-14 07:07:24 UTC
  • Revision ID: mbp@sourcefrog.net-20050314070724-ba6c85db7d96c508
- add setup.py and install instructions
- rename main script to just bzr

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 <http://www.gnu.org/>, and a project
8
 
of Canonical <http://www.canonical.com/>.
9
 
 
10
 
Ready-to-install packages are available for most popular operating systems from
11
 
<http://wiki.bazaar.canonical.com/Download/> or you can install from source by
12
 
following the instructions in the INSTALL file.
13
 
 
14
 
To learn how to use Bazaar, see the official documentation in the `doc`
15
 
directory or at <http://doc.bazaar.canonical.com/en/>.
16
 
 
17
 
For additional training materials including screencasts and slides,
18
 
visit our community wiki documentation page at:
19
 
 
20
 
    http://wiki.bazaar.canonical.com/Documentation/
21
 
 
22
 
Bazaar is Free Software, and is released under the GNU General Public License,
23
 
version 2 or later.
24
 
 
25
 
Bazaar highlights
26
 
=================
27
 
 
28
 
Bazaar directly supports both central version control (like cvs/svn) and
29
 
distributed version control (like git/hg). Developers can organize their
30
 
workspace in whichever way they want on a per project basis including:
31
 
 
32
 
* checkouts (like svn)
33
 
* feature branches (like hg)
34
 
* shared working tree (like git).
35
 
 
36
 
It also directly supports and encourages a large number of development best
37
 
practices like refactoring and pre-commit regression testing. Users can
38
 
choose between our command line tool and our cross-platform GUI application.
39
 
For further details, see our website at http://bazaar-vcs.org/en.
40
 
 
41
 
Feedback
42
 
========
43
 
 
44
 
If you encounter any problems with Bazaar, need help understanding it, or would
45
 
like to offer suggestions or feedback, please get in touch with us:
46
 
 
47
 
* Ask a question through our web support interface, at 
48
 
  https://answers.launchpad.net/bzr/
49
 
 
50
 
* Report bugs at https://bugs.launchpad.net/bzr/+filebug
51
 
 
52
 
* Write to us at bazaar@lists.canonical.com 
53
 
  You can join the list at <https://lists.ubuntu.com/mailman/listinfo/bazaar>.
54
 
  You don't need to subscribe to post, but your first post will be held 
55
 
  briefly for manual moderation.
56
 
 
57
 
* Talk to us in irc://irc.ubuntu.com/bzr
58
 
 
59
 
Our mission is to make a version control tool that developers LOVE to use
60
 
and that casual contributors feel confident with. Please let us know how
61
 
we're going.
62
 
 
63
 
The Bazaar Team
 
1
***********************************
 
2
Release notes for Bazaar-NG (pre-0)
 
3
***********************************
 
4
 
 
5
mbp@sourcefrog.net, March 2005, Canberra
 
6
 
 
7
 
 
8
 
 
9
Caveats
 
10
-------
 
11
 
 
12
 
 
13
* There is little locking or transaction control here; if you
 
14
  interrupt it the tree may be arbitrarily broken.  This will be
 
15
  fixed.
 
16
 
 
17
* Don't use this for critical data; at the very least keep separate
 
18
  regular snapshots of your tree.
 
19
 
 
20
 
 
21
Dependencies
 
22
------------
 
23
 
 
24
This is mostly developed on Linux (Ubuntu); it should work on Unix,
 
25
Windows, or OS X with relatively little trouble.
 
26
 
 
27
bzr requires a fairly recent Python, say after 2.2.  2.4 is recommended.
 
28
 
 
29
You must install either cElementTree_ or ElementTree_ first.
 
30
 
 
31
.. _cElementTree: http://effbot.org/zone/celementtree.htm
 
32
.. _ElementTree: http://effbot.org/zone/element-index.htm
 
33
 
 
34
 
 
35
 
 
36
Installation
 
37
------------
 
38
 
 
39
bzr has a standard python ``setup.py`` script.  
 
40
 
 
41
To install it system-wide::
 
42
 
 
43
  # python ./setup.py install
 
44
 
 
45
Alternatively you can simply put the source directory on $PYTHONPATH
 
46
and $PATH.