annotate INSTALL.md @ 1017:c30f0dc9d614

man: add libirccd-subst.3 manual page
author David Demelier <markand@malikania.fr>
date Wed, 17 Feb 2021 23:30:39 +0100
parents 201ddc487807
children 8f8ce47aba8a
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
1008
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
4 This guide will help you to install irccd
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
1008
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
9 Build dependencies:
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
1008
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
11 - C99 and few features from C11 (stdatomics, stdnoreturn).
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
12 - [Bison][] and [Flex][]: For configuration files.
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
13 - [CMake][]: Portable build system.
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
14
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
15 Optional runtime dependencies:
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
16
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
17 - [OpenSSL][]: Used for SSL connections to IRC servers (recommended).
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
18 - [CURL][]: Required for the links plugin.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 Basic installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 ------------------
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 This is the quick way to install irccd.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
71
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
25 tar xvzf irccd-x.y.z-tar.xz
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
26 cd irccd-x.y.z
697
6bc92086b2a6 Misc: update INSTALL.md
David Demelier <markand@malikania.fr>
parents: 464
diff changeset
27 mkdir build
6bc92086b2a6 Misc: update INSTALL.md
David Demelier <markand@malikania.fr>
parents: 464
diff changeset
28 cd build
71
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
29 cmake .. -DCMAKE_BUILD_TYPE=Release
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
30 make
d7d0e239fb0e Misc: add proper EOF
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
31 sudo make install
1008
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
32
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
33 [Bison]: https://www.gnu.org/software/bison
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
34 [CMake]: http://www.cmake.org
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
35 [CURL]: https://curl.se
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
36 [Flex]: https://github.com/westes/flex
201ddc487807 irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents: 899
diff changeset
37 [OpenSSL]: http://openssl.org