kde-extraapps/kuassel/INSTALL
Ivailo Monev b198db5877 kuassel: refactiring
Here is a short list of what exactly changed:
 - made it run only single instance via KUniqueApplication
 - make it store config and data in KDE directories
 - added irc protocol service provider files for use in KDE
 - removed Dock and Phonon notification support
 - removed Web links preview support
 - rebranded (incomplete, but mostly done)

Things that need doing:
 - use KDE localiztion implementation
 - the --url argument needed for the service does not actually join
 - use KStyle instead of stylesheets?
 - implement a help menu like other KDE apps
 - integrate with various KDE parts?
2014-12-30 16:16:27 +00:00

78 lines
3.2 KiB
Text

Quassel IRC - Installation Notes
================================
These should help you to install Quassel IRC from source. Note that this focuses
mostly on building on Linux; please feel free to send patches for build
instructions on other platforms. We are not familiar with them.
There is one version of Quassel that can be built - standalone, often called
"monolithic" or "mono client", contains both a client and a core and can be
used like a "normal" IRC client, without having to setup a server daemon.
Prerequisites
-------------
Of course, for building Quassel you need the usual set of build tools, for
example a compiler. As we use a subset of the C++11 standard, we require a
fairly recent compiler:
- gcc 4.7+ (available for most platforms), or
- Clang 3.2+ (available for most platforms, or
- XCode 4.6+ (available for Max OS X and based on Clang), or
- Visual C++ 2013 (available for Windows™), or
- any other compiler with decent C++11 support
Furthermore, CMake 2.8.9 or later is required.
As Quassel is a Qt application, you need the Qt SDK, either Qt 4.6+ or Qt 5.2+.
There are several optional dependencies; we will talk about that later.
Compiling Quassel - short version
---------------------------------
Quassel uses CMake as its build system. The canonical way to build any CMake-
based project is as follows:
cd /path/to/source
mkdir build
cd build
cmake ..
make
make install
Compiling Quassel - long version
--------------------------------
First of all, it is highly recommended for any CMake-based project to be built
in a separate build directory rather than in-source. That way, your source
checkout remains pristine, and you can easily remove any build artifacts by just
deleting the build directory. This directory can be located anywhere; in the
short example above, we just created a directory called "build" inside the
source checkout.
From inside the build directory, you can then run the "cmake" command, followed
by the path to the source. Additionally, you can append various options. Note
that CMake caches the options you provide on the command line, so if you rerun
it later in the same build directory, you don't need to specify them again.
Quassel supports several options to enable or disable features, and can make
use of several optional dependencies if installed. CMake will give a nice
summary of all that after its run.
You can find the list of optional packages for additional features in CMake's
feature summary; install missing packages for enabling the functionality listed
in the explanation. If you want to forcefully disable an optional feature, use
-DCMAKE_DISABLE_FIND_PACKAGE_Foo=TRUE, where "Foo" is the package name listed.
Quassel also supports the usual CMake options, most importantly
-DCMAKE_INSTALL_PREFIX=/prefix/path - specify the installation prefix
-DCMAKE_BUILD_TYPE=(Debug|Release|RelWithDebug) - specify the build type
If you want to narrow down the languages to be installed, you can set the
LINGUAS environment variable with a space-separated list of language codes,
for example LINGUAS="de en_US".
After running CMake, you can just run "make" in the build directory, and
"make install" for installing the result into the installation prefix.