← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to README

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
2
2
README for Bazaar
3
3
=================
4
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.
 
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).
24
25
 
25
26
Bazaar highlights
26
27
=================
27
28
 
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.canonical.com/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
 
 
 
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.
 
67
 
 
68
Registration and Feedback
 
69
=========================
 
70
 
 
71
If you would like to help us improve Bazaar by telling us about yourself and
 
72
what we could do better, please register and complete the online survey here:
 
73
http://www.surveymonkey.com/s.aspx?sm=L94RvLswhKdktrxiHWiX3g_3d_3d.
 
74
 
 
75
Registration is completely optional. If you would like to provide feedback
 
76
in other ways, see http://bazaar-vcs.org/BzrSupport for alternative ways of
 
77
getting in contact with us.
 
78
 
 
79
Enjoy,
63
80
The Bazaar Team