Mercurial > irccd

annotate INSTALL.md @ 0:1158cffe5a5e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children d7d0e239fb0e
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 This guide will help you to install irccd on your computer. For a better guide
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 with more details see:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 http://projects.malikania.fr/irccd/guide.html
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 Requirements
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 ------------
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 - GCC 5.1 or Clang 3.4,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 - [CMake](http://www.cmake.org). Used to build irccd.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 Optional:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 - [OpenSSL](http://openssl.org), Used for SSL connections to IRC servers, recommended,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 - [Pandoc](http://pandoc.org). Used for documentation process,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 - [Doxygen](http://www.stack.nl/~dimitri/doxygen). For the documentation about irccd internals.
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 tar xvzf irccd-x.y.z-tar.xz
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 cd irccd-x.y.z
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 mkdir _build_
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 cd _build_
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 cmake .. -DCMAKE_BUILD_TYPE=Release
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 make
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 sudo make install
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 ````