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}
_{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`.

2.8 KiB Raw Blame History