view INSTALL.md @ 428:ce1903f4bdb7 release-2.1

Fix #637: check for domain and family options The decision was not clear between the two option names, the documentation stated to use family but the code checked for family. Accept both for compatibility purposes and unify the documentation using the family name. Task: #637 Errata: 20170218
author David Demelier <markand@malikania.fr>
date Sat, 18 Feb 2017 09:08:51 +0100
parents 7efbaf3800b9
children 4dd28f5416fe
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/guide.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