Changeset b5cc87e

Timestamp:

2015-10-30T13:13:19Z (9 years ago)

Author:

dequis <dx@…>

Branches:

master

Children:

abf4717

Parents:

9516bb6

git-author:

dequis <dx@…> (30-10-15 13:12:05)

git-committer:

dequis <dx@…> (30-10-15 13:13:19)

Message:

A bunch of completely arbitrary changes to the README

File:

• README.md (modified) (1 diff)

README.md

@@ -16 +16 @@
 License: GPLv2
 
-## Development
+## Installation
 
-Use github pull requests against the 'develop' branch to submit patches.
+BitlBee is available in the package managers of most distros.
 
-The 'master' branch should be stable enough to be usable by users of the APT repo, but only requires a few days of testing in the 'develop' branch.
+For debian/ubuntu/etc you may use the nightly APT repository: http://code.bitlbee.org/debian/
 
-Building:
+You can also use a public server (such as `im.bitlbee.org`) instead of installing it: http://bitlbee.org/main.php/servers.html
 
-```
-./configure --debug=1
-# or, for a local install:
-# ./configure --debug=1 --prefix=$HOME/bitlbee --config=$HOME/bitlbee --pidfile=$HOME/bitlbee/bitlbee.pid
+## Compiling
 
-# Also try --asan=1 for AddressSanitizer
+If you wish to compile it yourself, ensure you have the following packages and their headers:
 
-make
+* glib 2.16 or newer (not to be confused with glibc)
+* gnutls
+* python 2 or 3 (for the user guide)
 
-BITLBEE_DEBUG=1 ./bitlbee -Dnv
-```
+Some optional features have additional dependencies, such as libpurple, libotr, libevent, etc.
+NSS and OpenSSL are also available but not as well supported as GnuTLS.
 
-See ./doc/README and ./doc/HACKING for more details.
+Once you have the dependencies, building should be a matter of:
 
-Mappings of bzr revisions to git commits (for historical purposes) are available in ./doc/git-bzr-rev-map
+    ./configure
+    make
+    sudo make install
+
+## Development tips
+
+* To enable debug symbols: `./configure --debug=1`
+* To get some additional debug output for some protocols: `BITLBEE_DEBUG=1 ./bitlbee -Dnv`
+* Use github pull requests against the 'develop' branch to submit patches.
+* The coding style based on K&R with tabs and 120 columns. See `./doc/uncrustify.cfg` for the parameters used to reformat the code.
+* Mappings of bzr revisions to git commits (for historical purposes) are available in `./doc/git-bzr-rev-map`
+* See also `./doc/README` and `./doc/HACKING`
 
 ## Help?
 
-Join **#BitlBee** on OFTC (**irc.oftc.net**) (OFTC, *not* FreeNode!) and flame us right in the face. :-)
+Join **#BitlBee** on OFTC (**irc.oftc.net**) (OFTC, *not* FreeNode!)