README.rst
1Breezy (``brz``) is a decentralized revision control system, designed to be
2easy for developers and end users alike.
3
4By default, Breezy provides support for both the `Bazaar
5<https://www.bazaar-vcs.org>`_ and `Git <https://www.git-scm.com/>`_ file
6formats.
7
8You can install from source by following the instructions in the INSTALL file.
9At the moment of writing there are no binary packages available.
10
11To learn how to use Breezy, see the official documentation in the `doc`
12directory or refer to the Bazaar documentation at
13<https://www.breezy-vcs.org/doc/en/>.
14
15Breezy is Free Software, and is released under the GNU General Public License,
16version 2 or later.
17
18Breezy is a friendly fork of the Bazaar (``bzr``) project, hosted on
19http://bazaar.canonical.com/. It is backwards compatibility with
20Bazaar's disk format and protocols. One of the key differences with
21Bazaar is that Breezy runs on Python 3.3 and later, rather than on
22Python 2.
23
24Breezy highlights
25=================
26
27Breezy directly supports both central version control (like cvs/svn) and
28distributed version control (like git/hg). Developers can organize their
29workspace in whichever way they want on a per project basis including:
30
31* checkouts (like svn)
32* feature branches (like hg)
33* shared working tree (like git).
34
35It also directly supports and encourages a large number of development best
36practices like refactoring and pre-commit regression testing. Users can
37choose between our command line tool and our cross-platform GUI application.
38For further details, see our website.
39
40Feedback
41========
42
43If you encounter any problems with Breezy, need help understanding it, or would
44like to offer suggestions or feedback, please get in touch with us:
45
46* Ask a question through our web support interface, at
47 https://answers.launchpad.net/brz/
48
49* Report bugs at https://bugs.launchpad.net/brz/+filebug
50
51* Write to the mailing list at bazaar@lists.canonical.com
52 You can join the list at <https://lists.ubuntu.com/mailman/listinfo/bazaar>.
53 You don't need to subscribe to post, but your first post will be held
54 briefly for manual moderation.
55
56 Please mention that you are using Breezy rather than Bazaar.
57
58* Talk to us in irc://irc.freenode.net/bzr
59
60 Please mention that you are using Breezy rather than Bazaar.
61
62Our mission is to make a version control tool that developers LOVE to use
63and that casual contributors feel confident with. Please let us know how
64we're going.
65
66The Breezy Team
67
README_BDIST_RPM
1There is a bug in disttools for distributions who's rpmbuild compresses
2the man pages. This causes an error building the final packages as it's
3expecting bzr.1 and not finding it, but finding bzr.1.gz that's unpackaged.
4
5This bug is known to affect Fedora, RHEL, and Centos distributions.
6
7There is a preliminary patch at http://bugs.python.org/issue644744 that
8fixes this issue with disttools.
9