Changes in README.md [b5cc87e:e26aa72]

File:

• README.md (modified) (1 diff)

README.md

@@ -16 +16 @@
 License: GPLv2
 
-## Installation
+## Development
 
-BitlBee is available in the package managers of most distros.
+Use github pull requests against the 'develop' branch to submit patches.
 
-For debian/ubuntu/etc you may use the nightly APT repository: http://code.bitlbee.org/debian/
+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.
 
-You can also use a public server (such as `im.bitlbee.org`) instead of installing it: http://bitlbee.org/main.php/servers.html
+Building:
 
-## Compiling
+```
+./configure --debug=1
+# or, for a local install:
+# ./configure --debug=1 --prefix=$HOME/bitlbee --config=$HOME/bitlbee --pidfile=$HOME/bitlbee/bitlbee.pid
 
-If you wish to compile it yourself, ensure you have the following packages and their headers:
+# Also try --asan=1 for AddressSanitizer
 
-* glib 2.16 or newer (not to be confused with glibc)
-* gnutls
-* python 2 or 3 (for the user guide)
+make
 
-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.
+BITLBEE_DEBUG=1 ./bitlbee -Dnv
+```
 
-Once you have the dependencies, building should be a matter of:
+See ./doc/README and ./doc/HACKING for more details.
 
-    ./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`
+Mappings of bzr revisions to git commits (for historical purposes) are available in ./doc/git-bzr-rev-map
 
 ## Help?
 
-Join **#BitlBee** on OFTC (**irc.oftc.net**) (OFTC, *not* FreeNode!)
+Join **#BitlBee** on OFTC (**irc.oftc.net**) (OFTC, *not* FreeNode!) and flame us right in the face. :-)