X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=INSTALL;h=112bd62c217403eed117b92d0b5e8d341aba5c79;hp=5d76c0ca732a584a19aad6fc1dc682c049bb56db;hb=2ef87aa6bfc05e76fb46cde4d9ed50975f70040c;hpb=d6b056e936ec441258d291b7a8af7b83f9f53016 diff --git a/INSTALL b/INSTALL index 5d76c0ca..112bd62c 100644 --- a/INSTALL +++ b/INSTALL @@ -1,26 +1,36 @@ -These are preliminary instructions, until we get the config more polished. +Quassel IRC - Installation Notes +================================ -To build Quassel IRC, cd to build/ and run qmake && make. This builds all three -versions of Quassel. You may choose individual targets by setting qmakes BUILD -variable: +These are preliminary instructions, until we get the config more +polished. + +Quassel IRC provides three binaries: quasselcore, quasselclient, and +quassel. While quasselcore and quasselclient obviously provide the +separated core and client functionality, the latter one (quassel) is a +monolithic version containing both of them for convenience. + +To build Quassel IRC, cd to build/ and run qmake && make. This +builds all three versions of Quassel. You may choose individual +targets by setting qmakes BUILD variable: qmake BUILD= -where is any combination of qtclient, core, mono or all. Note that in order -to change this later, you will have to make distclean, otherwise the BUILD setting -seems to be ignored by qmake. +where is any combination of qtclient, core, mono or all. Note +that in order to change this later, you will have to make distclean, +otherwise the BUILD setting seems to be ignored by qmake. After running make, you will find the binaries in build/targets. -make install will probably do something, but it has never been tried and may destroy -your system or kill a kitten. It's not necessary anyway, since there are no installable -files other than the binaries. Though this might change in later releases. +make install will probably do something, but it has never been tried +and may destroy your system or kill a kitten. It's not necessary +anyway, since there are no installable files other than the +binaries. Though this might change in later releases. -On first run of the Quassel core, it will wait for a client to connect and present a -(preliminary) first-run wizard. This will allow you to create the database and one -admin user for the core-side storage. Note that Quassel does not support the -administration of user accounts yet, this includes adding more users, changing passwords -and so on. This is high on our TODO list, of course. +On first run of the Quassel core, it will wait for a client to connect +and present a wizard that will allow you to create the database and one +admin user for the core-side storage. Note that Quassel does not support +the administration of user accounts yet, this includes adding more users, +changing passwords and so on. Please also do read the README file.