Mercurial > irccd

view INSTALL.md @ 550:64cb98dd8e9d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccd: finish custom IRC library, closes #581 Finally remove the lovely libircclient that has been used since the beginning of irccd back in 2013. Several issues made the choice of developing a custom IRC library: - libircclient requires select(2) system call and works in procedural paradigm which is incompatible with our Boost.Asio main loop, - there was no way in the libircclient to detect custom message like PING to handle dead servers, this required to bundle the library within the application, - the library use static output buffer which requires to keep an internal queue of commands that we flush at each iteration.
author David Demelier <markand@malikania.fr>
date Fri, 24 Nov 2017 20:05:15 +0100
parents 4dd28f5416fe
children 6bc92086b2a6
line wrap: on
line source

IRC Client Daemon INSTALL
=========================

This guide will help you to install irccd on your computer. For a better guide
with more details see:

    http://projects.malikania.fr/irccd//build/build-from-sources.html

Requirements
------------

  - GCC 5.1 or Clang 3.4,
  - [CMake](http://www.cmake.org). Used to build irccd.

Optional:

  - [OpenSSL](http://openssl.org), Used for SSL connections to IRC servers,
    recommended,
  - [Pandoc](http://pandoc.org), Used for documentation process,
  - [Doxygen](http://www.stack.nl/~dimitri/doxygen), For the documentation about
    irccd internals.

Basic installation
------------------

This is the quick way to install irccd.

    tar xvzf irccd-x.y.z-tar.xz
    cd irccd-x.y.z
    mkdir _build_
    cd _build_
    cmake .. -DCMAKE_BUILD_TYPE=Release
    make
    sudo make install