view INSTALL.md @ 796:1a6152af0866

misc: use ipv4 as option rather than family Now, all sections and JSON options that require a IP family will take ipv4 and ipv6 boolean options for convenience. It reduces parsing complexity and is more convenient for the user. Examples: # IPv6 server only [server] name = example port = 6667 hostname = example.org ipv4 = false ipv6 = true # IPv4 transport only [transport] type = ip ipv4 = true ipv6 = false port = 3320 If both options are defined (default everywhere), both protocols will be tried or bound.
author David Demelier <markand@malikania.fr>
date Sun, 11 Nov 2018 14:56:04 +0100
parents 6bc92086b2a6
children 00a4720c4874
line wrap: on
line source

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

This guide will help you to install irccd on your computer.

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

  - GCC 5.1 or Clang 3.4,
  - [Boost](http://boost.org),
  - [CMake](http://www.cmake.org).

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