Changeset b5cc87e


Ignore:
Timestamp:
2015-10-30T13:13:19Z (4 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:
1 edited

Legend:

Unmodified
Added
Removed
  • README.md

    r9516bb6 rb5cc87e  
    1616License: GPLv2
    1717
    18 ## Development
     18## Installation
    1919
    20 Use github pull requests against the 'develop' branch to submit patches.
     20BitlBee is available in the package managers of most distros.
    2121
    22 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.
     22For debian/ubuntu/etc you may use the nightly APT repository: http://code.bitlbee.org/debian/
    2323
    24 Building:
     24You can also use a public server (such as `im.bitlbee.org`) instead of installing it: http://bitlbee.org/main.php/servers.html
    2525
    26 ```
    27 ./configure --debug=1
    28 # or, for a local install:
    29 # ./configure --debug=1 --prefix=$HOME/bitlbee --config=$HOME/bitlbee --pidfile=$HOME/bitlbee/bitlbee.pid
     26## Compiling
    3027
    31 # Also try --asan=1 for AddressSanitizer
     28If you wish to compile it yourself, ensure you have the following packages and their headers:
    3229
    33 make
     30* glib 2.16 or newer (not to be confused with glibc)
     31* gnutls
     32* python 2 or 3 (for the user guide)
    3433
    35 BITLBEE_DEBUG=1 ./bitlbee -Dnv
    36 ```
     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.
    3736
    38 See ./doc/README and ./doc/HACKING for more details.
     37Once you have the dependencies, building should be a matter of:
    3938
    40 Mappings of bzr revisions to git commits (for historical purposes) are available in ./doc/git-bzr-rev-map
     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`
    4151
    4252## Help?
    4353
    44 Join **#BitlBee** on OFTC (**irc.oftc.net**) (OFTC, *not* FreeNode!) and flame us right in the face. :-)
     54Join **#BitlBee** on OFTC (**irc.oftc.net**) (OFTC, *not* FreeNode!)
Note: See TracChangeset for help on using the changeset viewer.