~bzr-pqm/bzr/bzr.dev

2545.1.1 by Martin Pool
Fix typo and remove version number from README
1
=================
2
README for Bazaar
3
=================
1904.3.1 by Adeodato Simó
Revamp README file for Bazaar 0.9.
4
3092.2.1 by Martin Pool
Ask people to report bugs to Launchpad, and mention more support options
5
Bazaar (``bzr``) is a decentralized revision control system, designed to be
6
easy for developers and end users alike.
1904.3.1 by Adeodato Simó
Revamp README file for Bazaar 0.9.
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
3092.2.1 by Martin Pool
Ask people to report bugs to Launchpad, and mention more support options
22
Bazaar was formerly known as Bazaar-NG.  It's the successor to ``baz``, a fork
23
of GNU arch, but shares no code.  (To upgrade from Baz, use the ``baz-import``
24
command in the bzrtools plugin.)
1904.3.1 by Adeodato Simó
Revamp README file for Bazaar 0.9.
25
26
Bazaar highlights
27
=================
28
3163.1.1 by Martin Pool
README ReST syntax fix
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.
1904.3.1 by Adeodato Simó
Revamp README file for Bazaar 0.9.
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
3163.1.1 by Martin Pool
README ReST syntax fix
60
   Changes will never be merged more than once, conflicts will be
61
   minimized, and identical changes are dealt with well.
1904.3.1 by Adeodato Simó
Revamp README file for Bazaar 0.9.
62
63
 * Vibrant and active community.
64
65
   Help with Bazaar is obtained easily, via the mailing list, or the IRC
3092.2.1 by Martin Pool
Ask people to report bugs to Launchpad, and mention more support options
66
   channel.
67
2688.1.1 by Ian Clatworthy
Added link to registration survey to README
68
69
Registration and Feedback
70
=========================
71
3092.2.1 by Martin Pool
Ask people to report bugs to Launchpad, and mention more support options
72
If you encounter any problems with Bazaar, need help understanding it, or would
73
like to offer suggestions or feedback, please get in touch with us:
74
75
 * Ask a question through our web support interface, at 
76
   https://answers.launchpad.net/bzr/
77
78
 * Report bugs at https://bugs.edge.launchpad.net/bzr/+filebug
79
80
 * Write to us at bazaar@lists.canonical.com 
81
   You can join the list at <https://lists.ubuntu.com/mailman/listinfo/bazaar>.
82
   You don't need to subscribe to post, but your first post will be held 
83
   briefly for manual moderation.
84
85
 * Talk to us in irc://irc.ubuntu.com/bzr
86
87
 * And see http://bazaar-vcs.org/BzrSupport for more.
88
2688.1.1 by Ian Clatworthy
Added link to registration survey to README
89
If you would like to help us improve Bazaar by telling us about yourself and
90
what we could do better, please register and complete the online survey here:
3092.2.1 by Martin Pool
Ask people to report bugs to Launchpad, and mention more support options
91
http://www.surveymonkey.com/s.aspx?sm=L94RvLswhKdktrxiHWiX3g_3d_3d.  
92
Registration is completely optional. 
2688.1.1 by Ian Clatworthy
Added link to registration survey to README
93
94
Enjoy,
95
The Bazaar Team