| [e26aa72] | 1 | # BitlBee |
|---|
| 2 | |
|---|
| [896bea2] | 3 |  |
|---|
| [e26aa72] | 4 | |
|---|
| [10425b2] | 5 | [](https://github.com/bitlbee/bitlbee/actions/workflows/test.yaml) |
|---|
| [e26aa72] | 6 | [](https://scan.coverity.com/projects/4028) |
|---|
| 7 | |
|---|
| 8 | An IRC to other chat networks gateway |
|---|
| 9 | |
|---|
| [896bea2] | 10 | Main website: https://www.bitlbee.org/ |
|---|
| [e26aa72] | 11 | |
|---|
| [896bea2] | 12 | Bug tracker: https://bugs.bitlbee.org/ |
|---|
| [e26aa72] | 13 | |
|---|
| [896bea2] | 14 | Wiki: https://wiki.bitlbee.org/ |
|---|
| [e26aa72] | 15 | |
|---|
| 16 | License: GPLv2 |
|---|
| 17 | |
|---|
| [b5cc87e] | 18 | ## Installation |
|---|
| [e26aa72] | 19 | |
|---|
| [b5cc87e] | 20 | BitlBee is available in the package managers of most distros. |
|---|
| [e26aa72] | 21 | |
|---|
| [896bea2] | 22 | For debian/ubuntu/etc you may use the nightly APT repository: https://code.bitlbee.org/debian/ |
|---|
| [e26aa72] | 23 | |
|---|
| [896bea2] | 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 |
|---|
| [e26aa72] | 25 | |
|---|
| [b5cc87e] | 26 | ## Compiling |
|---|
| [e26aa72] | 27 | |
|---|
| [b5cc87e] | 28 | If you wish to compile it yourself, ensure you have the following packages and their headers: |
|---|
| [e26aa72] | 29 | |
|---|
| [3a547ee] | 30 | * glib 2.32 or newer (not to be confused with glibc) |
|---|
| [b5cc87e] | 31 | * gnutls |
|---|
| 32 | * python 2 or 3 (for the user guide) |
|---|
| [e26aa72] | 33 | |
|---|
| [b5cc87e] | 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. |
|---|
| [e26aa72] | 36 | |
|---|
| [b5cc87e] | 37 | Once you have the dependencies, building should be a matter of: |
|---|
| [e26aa72] | 38 | |
|---|
| [b5cc87e] | 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` |
|---|
| [e26aa72] | 51 | |
|---|
| 52 | ## Help? |
|---|
| 53 | |
|---|
| [67f4cfe] | 54 | Join **#BitlBee** on OFTC (**irc.oftc.net**) (OFTC, *not* freenode!) |
|---|
