2017-03-31 00:57:58 +02:00
|
|
|
# charybdis/5
|
2015-02-25 03:32:08 +01:00
|
|
|
|
2017-03-31 00:57:58 +02:00
|
|
|
Charybdis is a collaboration server designed to be scalable and community-developed.
|
2016-01-23 20:52:57 +01:00
|
|
|
|
2017-03-31 00:57:58 +02:00
|
|
|
It implements communication protocols for Matrix and IRC.
|
2015-02-25 03:32:08 +01:00
|
|
|
|
2017-03-31 00:57:58 +02:00
|
|
|
## Building from git
|
2015-02-25 03:32:08 +01:00
|
|
|
|
2017-03-31 00:57:58 +02:00
|
|
|
* `git clone https://github.com/charybdis-ircd/charybdis`
|
|
|
|
|
* `cd charybdis`
|
|
|
|
|
* `./configure`
|
|
|
|
|
* `make`
|
|
|
|
|
* `make install`
|
2015-02-25 03:32:08 +01:00
|
|
|
|
2017-03-31 00:57:58 +02:00
|
|
|
### Notable configuration options when building
|
2016-03-23 21:10:44 +01:00
|
|
|
|
2017-03-31 00:57:58 +02:00
|
|
|
* `--enable-debug`
|
|
|
|
|
* `--with-included-boost[=shared]`
|
|
|
|
|
* `--with-included-rocksdb[=shared]`
|
2017-08-23 23:45:41 +02:00
|
|
|
* `--with-included-js[=shared]`
|
2016-03-23 21:10:44 +01:00
|
|
|
|
2017-03-31 00:57:58 +02:00
|
|
|
## Platforms
|
2015-02-25 03:32:08 +01:00
|
|
|
|
2016-07-24 00:42:04 +02:00
|
|
|
[](https://github.com/charybdis-ircd/charybdis/tree/master)
|
|
|
|
|
*This branch is not meant for production. Use at your own risk.*
|
2016-03-06 00:49:13 +01:00
|
|
|
|
2016-07-24 00:42:04 +02:00
|
|
|
| <sub> Continuously Integrated Host </sub> | <sub> Compiler </sub> | <sub> Third party </sub> | <sub> Status </sub> |
|
|
|
|
|
|:------------------------------------------- |:------------------------ |:------------------------ |:------------------- |
|
|
|
|
|
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> GCC 5 </sub> | <sub> Boost 1.61 </sub> | [](https://travis-ci.org/charybdis-ircd/charybdis) |
|
|
|
|
|
| <sub> Linux Ubuntu 14.04 Trusty </sub> | <sub> GCC 6 </sub> | <sub> Boost 1.61 </sub> | [](https://travis-ci.org/charybdis-ircd/charybdis) |
|
|
|
|
|
| <sub> Linux Ubuntu 14.04 Trusty </sub> | <sub> Clang 3.8 </sub> | <sub> Boost 1.61 </sub> | [](https://travis-ci.org/charybdis-ircd/charybdis) |
|
|
|
|
|
| <sub> Apple Darwin 15.5 </sub> | <sub> LLVM 7.3.0 </sub> | <sub> Boost 1.61 </sub> | [](https://travis-ci.org/charybdis-ircd/charybdis) |
|
|
|
|
|
| <sub> Windows </sub> | <sub> mingw 3.5 </sub> | <sub> Boost 1.61 </sub> | [](https://ci.appveyor.com/project/kaniini/charybdis/branch/master) |
|
2016-03-06 00:49:13 +01:00
|
|
|
|
2017-03-31 00:57:58 +02:00
|
|
|
## Tips
|
2015-02-25 03:32:08 +01:00
|
|
|
|
|
|
|
|
* Please read doc/index.txt to get an overview of the current documentation.
|
|
|
|
|
|
2016-03-23 21:10:44 +01:00
|
|
|
* Read the NEWS file for what's new in this release.
|
|
|
|
|
|
2017-03-31 00:57:58 +02:00
|
|
|
## Git access
|
2016-04-10 23:49:42 +02:00
|
|
|
|
|
|
|
|
* The Charybdis GIT repository can be checked out using the following command:
|
2016-04-11 00:15:46 +02:00
|
|
|
`git clone https://github.com/charybdis-ircd/charybdis`
|
2016-04-10 23:49:42 +02:00
|
|
|
|
|
|
|
|
* Charybdis's GIT repository depot can be browsed over the Internet at the following address:
|
|
|
|
|
https://github.com/charybdis-ircd/charybdis
|
2017-08-23 23:45:41 +02:00
|
|
|
|
|
|
|
|
## 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`.
|
