Mercurial > irccd

view doc/doxygen/mainpage.cpp @ 850:688f28dd3241

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
irccd: remove short options, closes #1673 While here, use a brand new home made option parsing.
author David Demelier <markand@malikania.fr>
date Tue, 16 Jul 2019 20:49:36 +0200
parents 8460b4a34191
children
line wrap: on
line source

/**
 * \mainpage
 *
 * Welcome to the irccd C++ API.
 *
 * ## Introduction
 *
 * The irccd libraries let you create your own native plugins but also your own
 * bot from scratch if you want.
 *
 * ## Libraries
 *
 * The irccd libraries are split and described as following:
 *
 * | Library         | Description                                     | Dependencies                 |
 * |-----------------|-------------------------------------------------|------------------------------|
 * | libirccd        | Common utilities                                | libjson                      |
 * | libirccd-ctl    | Classes to connect to irccd instance            | libirccd-daemon              |
 * | libirccd-test   | Tools to create unit tests                      | libirccd-daemon, libirccd-js |
 * | libirccd-js     | Libraries to create Javascript APIs and plugins | libirccd-daemon, libduktape  |
 * | libirccd-daemon | Everything related to irccd instance            | libirccd                     |
 *
 * There is also external libraries shipped with irccd:
 *
 * | Library       | Description          | Link        |
 * |---------------|----------------------|-------------|
 * | libduktape    | Javascript engine    | [duktape][] |
 * | libjson       | Niels Lohmanns' JSON | [json][]    |
 *
 * [duktape]: http://duktape.org
 * [json]: https://github.com/nlohmann/json
 */