cmake | ||
core | ||
external | ||
packaging | ||
plugins | ||
resources | ||
shared | ||
translations | ||
ui | ||
.gitmodules | ||
appveyor.yml | ||
CHANGELOG.md | ||
CMakeLists.txt | ||
LICENSE.md | ||
README.md |
Squawk - a compact XMPP desktop messenger
Prerequisites
- QT 5.12 (lower versions might work but it wasn't tested)
- lmdb
- CMake 3.4 or higher
- qxmpp 1.1.0 or higher
- KDE Frameworks: kwallet (optional)
- KDE Frameworks: KIO (optional)
- KDE Frameworks: KConfig (optional)
- KDE Frameworks: KConfigWidgets (optional)
- Boost (just one little hpp from there)
- Imagemagick (for compilation, to rasterize an SVG logo)
Getting
The easiest way to get the Squawk is to install it from AUR (if you use Archlinux like distribution)
Here is the link for the AUR package
You can also install it from console if you use some AUR wrapper. Here what it's going to look like with pacaur
$ pacaur -S squawk
Building
You can also clone the repo and build it from source
Squawk requires Qt with SSL enabled. It uses CMake as build system.
Please check the prerequisites and install them before installation.
For Windows (Mingw-w64) build
You need Qt for mingw64 (MinGW 64-bit) platform when installing Qt.
The best way to acquire library lmdb
and boost
is through Msys2.
First install Msys2, and then install mingw-w64-x86_64-lmdb
and mingw-w64-x86_64-boost
by pacman.
Then you need to provide the cmake cache entry when calling cmake for configuration:
cmake .. -D LMDB_ROOT_DIR:PATH=<Msys2 Mingw64 Root Directory> -D BOOST_ROOT:PATH=<Msys2 Mingw64 Root Directory>
<Msys2 Mingw64 Root Directory>
: e.g. C:/msys64/mingw64
.
There are two ways to build, it depends whether you have qxmpp installed in your system
Building with system qxmpp
Here is what you do
$ git clone https://git.macaw.me/blue/squawk
$ cd squawk
$ mkdir build
$ cd build
$ cmake .. [-D LMDB_ROOT_DIR:PATH=...] [-D BOOST_ROOT:PATH=...]
$ cmake --build .
Building with bundled qxmpp
Here is what you do
$ git clone --recurse-submodules https://git.macaw.me/blue/squawk
$ cd squawk
$ mkdir build
$ cd build
$ cmake .. -D SYSTEM_QXMPP=False [-D LMDB_ROOT_DIR:PATH=...] [-D BOOST_ROOT:PATH=...]
$ cmake --build .
You can always refer to appveyor.yml
to see how AppVeyor build squawk.
List of keys
Here is the list of keys you can pass to configuration phase of cmake ..
.
CMAKE_BUILD_TYPE
-Debug
just builds showing all warnings,Release
builds with no warnings and applies optimizations (default isDebug
)SYSTEM_QXMPP
-True
tries to link againstqxmpp
installed in the system,False
builds bundledqxmpp
library (default isTrue
)WITH_KWALLET
-True
builds theKWallet
capability module ifKWallet
is installed and if not goes toFalse
.False
disablesKWallet
support (default isTrue
)WITH_KIO
-True
builds theKIO
capability module ifKIO
is installed and if not goes toFalse
.False
disablesKIO
support (default isTrue
)WITH_KCONFIG
-True
builds theKConfig
andKConfigWidgets
capability module if such packages are installed and if not goes toFalse
.False
disablesKConfig
andKConfigWidgets
support (default isTrue
)
License
This project is licensed under the GPLv3 License - see the LICENSE.md file for details