source: README.md

Last change on this file was 67f4cfe, checked in by Peter Powell <petpow@…>, at 2018-09-15T15:19:06Z

Fix the capitalisation of freenode's name.

  • Property mode set to 100644
File size: 1.8 KB
Line 
1# BitlBee
2
3![](https://www.bitlbee.org/style/logo.png)
4
5[![Build Status](https://travis-ci.org/bitlbee/bitlbee.svg)](https://travis-ci.org/bitlbee/bitlbee)
6[![Coverity Scan Build Status](https://scan.coverity.com/projects/4028/badge.svg)](https://scan.coverity.com/projects/4028)
7
8An IRC to other chat networks gateway
9
10Main website: https://www.bitlbee.org/
11
12Bug tracker: https://bugs.bitlbee.org/
13
14Wiki: https://wiki.bitlbee.org/
15
16License: GPLv2
17
18## Installation
19
20BitlBee is available in the package managers of most distros.
21
22For debian/ubuntu/etc you may use the nightly APT repository: https://code.bitlbee.org/debian/
23
24You 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
28If you wish to compile it yourself, ensure you have the following packages and their headers:
29
30* glib 2.16 or newer (not to be confused with glibc)
31* gnutls
32* python 2 or 3 (for the user guide)
33
34Some optional features have additional dependencies, such as libpurple, libotr, libevent, etc.
35NSS and OpenSSL are also available but not as well supported as GnuTLS.
36
37Once 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
54Join **#BitlBee** on OFTC (**irc.oftc.net**) (OFTC, *not* freenode!)
Note: See TracBrowser for help on using the repository browser.