X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=INSTALL;h=99ce60c7bc6b00eb73423c31dccf70f0a9cb53b5;hp=17d1310db81e4bd1ca2e93f42d1beab02f7c6227;hb=4ea4eba0a0a1c6e81032d3447e7222276fe8289e;hpb=8f124bf55d262a83580dc569f7d62da8b25b6177;ds=sidebyside diff --git a/INSTALL b/INSTALL index 17d1310d..99ce60c7 100644 --- a/INSTALL +++ b/INSTALL @@ -1,36 +1,72 @@ -These are preliminary instructions, until we get the config more -polished. +Quassel IRC - Installation Notes +================================ -Quassel IRC features three binaries: quasselcore, quasselclient, and +These should help you to install Quassel IRC from source. Please also have a +look at the README file! + +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: +Note that quasselcore is no longer being built by default, since it tends to +confuse users more than it helped. It will be back as soon as we have simple mode +implemented. + +We now use CMake as our build system. CMake supports and encourages out-of-source +builds, which do not clutter the source directory. You can (and should) thus use +an arbitrary directory for building. + +There is no "make distclean"; "make clean" should usually be enough since CMake +actually cleans up properly (qmake often didn't). If you really want to get rid +of all build files, just remove the build directory. + +Usually, you will build Quassel as follows: + +cd /path/to/build/dir +cmake /path/to/quassel +make + +Additionally, you may add some options to the cmake call, prefixed by -D. These need +to follow the source directory PATH: + +cmake /path/to/quassel -D -D + +NOTE: In order to reconfigure, you need to remove CMakeCache.txt (or empty + the build directory), otherwise cmake will ignore modified -D options! + +Quassel recognizes the following options: -qmake BUILD= +-DWANT_(CORE|QTCLIENT|MONO)=(ON|OFF) + Allow to choose which Quassel binaries to 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. +-DLINGUAS=" + Allow to choose which languages should be compiled into the binary. + is a space-separated list of language codes. + Example: -DLINGUAS="de en_US" -After running make, you will find the binaries in build/targets. +-DQT=/path/to/qt + Use a non-system Qt installation. This is for example useful if you have a static + Qt installed in some local dir. -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. +-DSTATIC=1 + Enable static building of Quassel. On Linux, you should link the static versions of some libs + (in particular libstdc++.a) into /path/to/build/dir/staticlibs in oder to create + a portable binary! Be aware of the fact that some things we do in STATIC mode might not be portable + or require a particular setup; it's mainly meant for the devel team. -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. +BUILDING ON WINDOWS: +-------------------- +We have tested building on Windows with a statically built Qt (with its /bin directory in %PATH%) +and MSVC 2005/2008. Make sure that you use a "shell" that has all needed env variables setup, +such as the "Visual Studio Command Prompt". You will also need the /bin of the Microsoft SDK in +your %PATH% at least for VS 2008, otherwise rc.exe is not found. +Currently, only building in the shell using nmake seems to work; CMake can also create MSVC project +files, but they seem to be problematic. However, YMMV. Software development on Windows is a real +PITA. -Please also do read the README file. +After you have everything setup: -Thanks, -~ The Quassel IRC Team +cd C:\path\to\quassel-build +cmake -G"NMake Makefiles" C:\path\to\quassel\source -DSTATIC=1 +nmake