From 685eed838af62f47bbab935d0a8c11e1bbeea1dc Mon Sep 17 00:00:00 2001 From: Sam Dodrill Date: Tue, 15 Apr 2014 10:40:12 -0700 Subject: [PATCH] README: Update README --- README.md | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 736581f..a7eeb6e 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,35 @@ -# elemental-ircd +# Elemental-IRCd -**elemental-ircd** is a high performance, lightweight, and scalable -IRC daemon. It is a fork of the now-defunct ShadowIRCD created to meet -PonyChat's needs, and seeks to continue in the direction ShadowIRCD -was headed. +**Elemental-IRCd** is a high performance, lightweight, and scalable +IRC daemon. It is a fork of the now-defunct ShadowIRCD and seeks to continue in +the direction ShadowIRCD was headed. ## Supported Platforms - If you put something on a platform which cannot support it - it may tip and fall and become broken. Simple physics. +All modern \*NIX systems should work. You need the equivalent of the following +Debian packages: + + - `libssl-dev` + - `flex` + - `bison` + - `build-essential` + +``` +Cassy | If you put something on a platform which cannot support it + | it may tip and fall and become broken. Simple physics. +``` + +Read the included documentation for detailed compilation and install +directions. ## Support -Our support channel is `#rainbow-factory` on `irc.ponychat.net`. Poke -**aji**, **lyska**, or **Kabaka** for help. +The official channel for Elemental-IRCd is `#elemental-ircd` on +`irc.yolo-swag.com`. Anyone with push access to the repository will have halfop +(`+h`, `%`) or higher. + +Atheme and Anope (1.8 and 2.0) modules are included in the source tree of +Elemental-IRCd. For most cases the default `protocol/elemental-ircd` module in +Atheme should be fine, but this version will always be more up-to-date. To report bugs, please use the GitHub issue tracker.