doc:index: mention that in-branch-bugs are not the only way
[be.git] / doc / index.txt
1 Welcome to the bugs-everywhere documentation!
2 =============================================
3
4 Bugs Everywhere (BE) is a bugtracker built on distributed version
5 control.  It works with Arch_, Bazaar_, Darcs_, Git_, Mercurial_, and
6 Monotone_ at the moment, but is easily extensible.  It can also
7 function with no VCS at all.
8
9 .. _Arch: http://www.gnu.org/software/gnu-arch/
10 .. _Bazaar: http://bazaar.canonical.com/
11 .. _Darcs: http://darcs.net/
12 .. _Git: http://git-scm.com/
13 .. _Mercurial: http://mercurial.selenic.com/
14 .. _Monotone: http://www.monotone.ca/
15
16 The idea is to package the bug information with the source code, so
17 that bugs can be marked "fixed" in the branches that fix them.  Other
18 architectures---such as keeping all the bugs in their own branch---are
19 also possible.
20
21
22 Contents:
23
24 .. toctree::
25    :maxdepth: 2
26
27    install
28    tutorial
29    config
30    email
31    http
32    distributed_bugtracking
33    power
34    hacking
35    spam
36    libbe/libbe
37    doc
38
39 Indices and tables
40 ==================
41
42 * :ref:`genindex`
43 * :ref:`modindex`
44 * :ref:`search`