aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authordequis <dx@dxzone.com.ar>2015-01-24 19:48:09 -0300
committerdequis <dx@dxzone.com.ar>2015-01-25 02:00:06 -0300
commite26aa728e6840678ea018ab979867730f4c7fb68 (patch)
tree33c382ab59339dcbb341ae43670f3421df4f5ddc /README.md
parenteb4ad8d31f7ed4210f24beb8753ecce594b0beef (diff)
Add git specific stuff!
- A few build system tweaks - A fancy README.md - s/.bzrignore/.gitignore/ - .travis.yml for travis-ci integration - doc/git-bzr-rev-map for historical purposes
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..5e0acb52
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# BitlBee
+
+![](http://bitlbee.org/style/logo.png)
+
+[![Build Status](https://travis-ci.org/bitlbee/bitlbee.svg)](https://travis-ci.org/bitlbee/bitlbee)
+[![Coverity Scan Build Status](https://scan.coverity.com/projects/4028/badge.svg)](https://scan.coverity.com/projects/4028)
+
+An IRC to other chat networks gateway
+
+Main website: http://www.bitlbee.org/
+
+Bug tracker: http://bugs.bitlbee.org/
+
+Wiki: http://wiki.bitlbee.org/
+
+License: GPLv2
+
+## Development
+
+Use github pull requests against the 'develop' branch to submit patches.
+
+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.
+
+Building:
+
+```
+./configure --debug=1
+# or, for a local install:
+# ./configure --debug=1 --prefix=$HOME/bitlbee --config=$HOME/bitlbee --pidfile=$HOME/bitlbee/bitlbee.pid
+
+# Also try --asan=1 for AddressSanitizer
+
+make
+
+BITLBEE_DEBUG=1 ./bitlbee -Dnv
+```
+
+See ./doc/README and ./doc/HACKING for more details.
+
+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!) and flame us right in the face. :-)