Merge branch 'cfbe'
[be.git] / doc / install.txt
1 *************
2 Installing BE
3 *************
4
5 Bazaar repository
6 =================
7
8 BE is available as a bzr repository::
9
10     $ bzr branch http://bzr.bugseverywhere.org/be
11
12 See the homepage_ for details.  If you do branch the bzr repo, you'll
13 need to run::
14
15     $ make
16
17 to build some auto-generated files (e.g. :mod:`libbe._version`), and::
18
19     $ make install
20
21 to install BE.  By default BE will install into your home directory,
22 but you can tweak the ``PREFIX`` variable in ``Makefile`` to install
23 to another location.
24
25 .. _homepage: http://bugseverywhere.org/
26
27
28 Release tarballs
29 ================
30
31 For those not interested in the cutting edge, or those who don't want
32 to worry about installing Bazaar, we'll post release tarballs somewhere
33 (once we actually make a release).  After you've downloaded the release
34 tarball, unpack it with::
35
36     $ tar -xzvf be-<VERSION>.tar.gz
37
38 And install it with:::
39
40     $ cd be-<VERSION>
41     $ make install
42
43
44 Distribution packages
45 =====================
46
47 Some distributions (Debian_ , Ubuntu_ , others?) package BE.  If
48 you're running one of those distributions, you can install the package
49 with your regular package manager.  For Debian, Ubuntu, and related
50 distros, that's::
51
52     $ apt-get install bugs-everywhere
53
54 .. _Debian: http://packages.debian.org/sid/bugs-everywhere
55 .. _Ubuntu: http://packages.ubuntu.com/lucid/bugs-everywhere