annotate INSTALL.md @ 875:2fa45dd207d0 stable-3

misc: create stable-3 branch
author David Demelier <markand@malikania.fr>
date Thu, 15 Aug 2019 21:57:08 +0200
parents 00a4720c4874
children 9f953fb28a60
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
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents: 697
diff changeset
9 - GCC 7.0 or Clang 6.0,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents: 697
diff changeset
10 - [Boost](http://boost.org),
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents: 697
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
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents: 697
diff changeset
15 - [OpenSSL](http://openssl.org), Used for SSL connections to IRC servers,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents: 697
diff changeset
16 recommended,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents: 697
diff changeset
17 - [UriParser](), Required for the links plugin,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents: 697
diff changeset
18 - [Doxygen](http://www.stack.nl/~dimitri/doxygen), For the documentation about
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents: 697
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