Mercurial > irccd

annotate INSTALL.md @ 796:1a6152af0866

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 IRC Client Daemon INSTALL
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 =========================
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3
697
6bc92086b2a6 Misc: update INSTALL.md
David Demelier <markand@malikania.fr>
parents: 464
diff changeset
4 This guide will help you to install irccd on your computer.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 Requirements
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 ------------
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 - GCC 5.1 or Clang 3.4,
697
6bc92086b2a6 Misc: update INSTALL.md
David Demelier <markand@malikania.fr>
parents: 464
diff changeset
10 - [Boost](http://boost.org),
6bc92086b2a6 Misc: update INSTALL.md
David Demelier <markand@malikania.fr>
parents: 464
diff changeset
11 - [CMake](http://www.cmake.org).
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 Optional:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
388
7efbaf3800b9 Misc: reduce .md files to 80 columns
David Demelier <markand@malikania.fr>
parents: 71
diff changeset
15 - [OpenSSL](http://openssl.org), Used for SSL connections to IRC servers,
7efbaf3800b9 Misc: reduce .md files to 80 columns
David Demelier <markand@malikania.fr>
parents: 71
diff changeset
16 recommended,
71
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
17 - [Pandoc](http://pandoc.org), Used for documentation process,
388
7efbaf3800b9 Misc: reduce .md files to 80 columns
David Demelier <markand@malikania.fr>
parents: 71
diff changeset
18 - [Doxygen](http://www.stack.nl/~dimitri/doxygen), For the documentation about
7efbaf3800b9 Misc: reduce .md files to 80 columns
David Demelier <markand@malikania.fr>
parents: 71
diff changeset
19 irccd internals.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 Basic installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 ------------------
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 This is the quick way to install irccd.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
71
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
26 tar xvzf irccd-x.y.z-tar.xz
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
27 cd irccd-x.y.z
697
6bc92086b2a6 Misc: update INSTALL.md
David Demelier <markand@malikania.fr>
parents: 464
diff changeset
28 mkdir build
6bc92086b2a6 Misc: update INSTALL.md
David Demelier <markand@malikania.fr>
parents: 464
diff changeset
29 cd build
71
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
30 cmake .. -DCMAKE_BUILD_TYPE=Release
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
31 make
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
32 sudo make install