17d1310db81e4bd1ca2e93f42d1beab02f7c6227
[quassel.git] / INSTALL
1 These are preliminary instructions, until we get the config more
2 polished.
3
4 Quassel IRC features three binaries: quasselcore, quasselclient, and
5 quassel. While quasselcore and quasselclient obviously provide the
6 separated core and client functionality, the latter one (quassel) is a
7 monolithic version containing both of them for convenience.
8
9 To build Quassel IRC, cd to build/ and run qmake && make. This
10 builds all three versions of Quassel. You may choose individual
11 targets by setting qmakes BUILD variable:
12
13 qmake BUILD=<foo>
14
15 where <foo> is any combination of qtclient, core, mono or all. Note
16 that in order to change this later, you will have to make distclean,
17 otherwise the BUILD setting seems to be ignored by qmake.
18
19 After running make, you will find the binaries in build/targets.
20
21 make install will probably do something, but it has never been tried
22 and may destroy your system or kill a kitten. It's not necessary
23 anyway, since there are no installable files other than the
24 binaries. Though this might change in later releases.
25
26 On first run of the Quassel core, it will wait for a client to connect
27 and present a (preliminary) first-run wizard. This will allow you to
28 create the database and one admin user for the core-side storage. Note
29 that Quassel does not support the administration of user accounts yet,
30 this includes adding more users, changing passwords and so on. This is
31 high on our TODO list, of course.
32
33 Please also do read the README file.
34
35 Thanks,
36 ~ The Quassel IRC Team