squawk/README.md

66 lines
1.8 KiB
Markdown
Raw Normal View History

2020-01-02 14:18:03 +00:00
# Squawk - a compact XMPP desktop messenger
2020-01-02 14:18:03 +00:00
[![AUR license](https://img.shields.io/aur/license/squawk?style=flat-square)](https://git.macaw.me/blue/squawk/raw/branch/master/LICENSE.md)
[![AUR version](https://img.shields.io/aur/version/squawk?style=flat-square)](https://aur.archlinux.org/packages/squawk/)
2020-01-02 14:19:00 +00:00
[![Donations](http://img.shields.io/liberapay/patrons/macaw.me.svg?logo=liberapay&style=flat-square)](https://liberapay.com/macaw.me)
2020-01-02 14:18:03 +00:00
![Squawk screenshot](https://macaw.me/images/squawk/0.1.2.png)
### Prerequisites
- QT 5.12 *(lower versions might work but it wasn't tested)*
2019-08-14 14:59:43 +00:00
- uuid _(usually included in some other package, for example it's ***libutil-linux*** in archlinux)_
- lmdb
- CMake 3.0 or higher
- qxmpp 1.1.0 or higher
### Getting
The easiest way to get the Squawk is to install it from AUR (if you use Archlinux like distribution)
Here is the [link](https://aur.archlinux.org/packages/squawk/) 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.
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
2019-08-14 15:00:51 +00:00
```
$ git clone https://git.macaw.me/blue/squawk
$ cd squawk
$ mkdir build
$ cd build
$ cmake ..
$ cmake --build .
2019-08-14 15:00:51 +00:00
```
#### 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
$ cmake --build .
```
## License
This project is licensed under the GPLv3 License - see the [LICENSE.md](LICENSE.md) file for details