README: Update README
This commit is contained in:
parent
d23dc975b3
commit
685eed838a
35
README.md
35
README.md
|
@ -1,18 +1,35 @@
|
||||||
# elemental-ircd
|
# Elemental-IRCd
|
||||||
|
|
||||||
**elemental-ircd** is a high performance, lightweight, and scalable
|
**Elemental-IRCd** is a high performance, lightweight, and scalable
|
||||||
IRC daemon. It is a fork of the now-defunct ShadowIRCD created to meet
|
IRC daemon. It is a fork of the now-defunct ShadowIRCD and seeks to continue in
|
||||||
PonyChat's needs, and seeks to continue in the direction ShadowIRCD
|
the direction ShadowIRCD was headed.
|
||||||
was headed.
|
|
||||||
|
|
||||||
## Supported Platforms
|
## Supported Platforms
|
||||||
|
|
||||||
<Cassy> If you put something on a platform which cannot support it
|
All modern \*NIX systems should work. You need the equivalent of the following
|
||||||
it may tip and fall and become broken. Simple physics.
|
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
|
## Support
|
||||||
|
|
||||||
Our support channel is `#rainbow-factory` on `irc.ponychat.net`. Poke
|
The official channel for Elemental-IRCd is `#elemental-ircd` on
|
||||||
**aji**, **lyska**, or **Kabaka** for help.
|
`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.
|
To report bugs, please use the GitHub issue tracker.
|
||||||
|
|
Loading…
Reference in New Issue