charybdis/5

Charybdis is a collaboration server designed to be scalable and community-developed.

It implements communication protocols for Matrix and IRC.

Building from git

* `git clone https://github.com/charybdis-ircd/charybdis`
* `cd charybdis`
* `./configure`
* `make`
* `make install`

Notable configuration options when building

* `--enable-debug`
* `--with-included-boost[=shared]`
* `--with-included-rocksdb[=shared]`
* `--with-included-js[=shared]`

Platforms

This branch is not meant for production. Use at your own risk.

Continuously Integrated Host	Compiler	Third party	Status
Linux Ubuntu 12.04 Precise	GCC 5	Boost 1.61
Linux Ubuntu 14.04 Trusty	GCC 6	Boost 1.61
Linux Ubuntu 14.04 Trusty	Clang 3.8	Boost 1.61
Apple Darwin 15.5	LLVM 7.3.0	Boost 1.61
Windows	mingw 3.5	Boost 1.61

Tips

• Please read doc/index.txt to get an overview of the current documentation.

• Read the NEWS file for what's new in this release.

Git access

• The Charybdis GIT repository can be checked out using the following command: git clone https://github.com/charybdis-ircd/charybdis

• Charybdis's GIT repository depot can be browsed over the Internet at the following address: https://github.com/charybdis-ircd/charybdis

Developers

Style

Misc

* When using a `switch` over an `enum` type, put what would be the `default` case after/outside
of the `switch` unless the situation specifically calls for one. We use -Wswitch so changes to
the enum will provide a good warning to update any `switch`.