1 | # BitlBee |
---|
2 | |
---|
3 | ![](https://www.bitlbee.org/style/logo.png) |
---|
4 | |
---|
5 | [![Tests](https://github.com/bitlbee/bitlbee/actions/workflows/test.yaml/badge.svg)](https://github.com/bitlbee/bitlbee/actions/workflows/test.yaml) |
---|
6 | [![Coverity Scan Build Status](https://scan.coverity.com/projects/4028/badge.svg)](https://scan.coverity.com/projects/4028) |
---|
7 | |
---|
8 | An IRC to other chat networks gateway |
---|
9 | |
---|
10 | Main website: https://www.bitlbee.org/ |
---|
11 | |
---|
12 | Bug tracker: https://bugs.bitlbee.org/ |
---|
13 | |
---|
14 | Wiki: https://wiki.bitlbee.org/ |
---|
15 | |
---|
16 | License: GPLv2 |
---|
17 | |
---|
18 | ## Installation |
---|
19 | |
---|
20 | BitlBee is available in the package managers of most distros. |
---|
21 | |
---|
22 | For debian/ubuntu/etc you may use the nightly APT repository: https://code.bitlbee.org/debian/ |
---|
23 | |
---|
24 | You can also use a public server (such as `im.bitlbee.org`) instead of installing it: https://www.bitlbee.org/main.php/servers.html |
---|
25 | |
---|
26 | ## Compiling |
---|
27 | |
---|
28 | If you wish to compile it yourself, ensure you have the following packages and their headers: |
---|
29 | |
---|
30 | * glib 2.32 or newer (not to be confused with glibc) |
---|
31 | * gnutls |
---|
32 | * python 2 or 3 (for the user guide) |
---|
33 | |
---|
34 | Some optional features have additional dependencies, such as libpurple, libotr, libevent, etc. |
---|
35 | NSS and OpenSSL are also available but not as well supported as GnuTLS. |
---|
36 | |
---|
37 | Once you have the dependencies, building should be a matter of: |
---|
38 | |
---|
39 | ./configure |
---|
40 | make |
---|
41 | sudo make install |
---|
42 | |
---|
43 | ## Development tips |
---|
44 | |
---|
45 | * To enable debug symbols: `./configure --debug=1` |
---|
46 | * To get some additional debug output for some protocols: `BITLBEE_DEBUG=1 ./bitlbee -Dnv` |
---|
47 | * Use github pull requests against the 'develop' branch to submit patches. |
---|
48 | * The coding style based on K&R with tabs and 120 columns. See `./doc/uncrustify.cfg` for the parameters used to reformat the code. |
---|
49 | * Mappings of bzr revisions to git commits (for historical purposes) are available in `./doc/git-bzr-rev-map` |
---|
50 | * See also `./doc/README` and `./doc/HACKING` |
---|
51 | |
---|
52 | ## Help? |
---|
53 | |
---|
54 | Join **#BitlBee** on OFTC (**irc.oftc.net**) (OFTC, *not* freenode!) |
---|