README

wiLink
Copyright (C) 2009-2015 Wifirst
See AUTHORS file for a full list of contributors.

About
=====

wiLink is an application for Wifirst customers, which runs on Windows,
Mac OS X, Linux and Android. It features:

 * a chat client which supports:
   - file transfers
   - voice and video calls
 * a soft phone (SIP) for telephone calls
 * a diagnostic tool which performs tests to diagnostic connectivity
   problems

License
=======

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Requirements
============

wiLink requires Qt >= 5.4 to build.

On Debian/Ubuntu
----------------

$ sudo apt-get install libqxmpp-dev libxss-dev qtbase5-dev qtmultimedia5-dev

On Mac OS X
-----------

Install Qt from https://www.qt.io/download/

Building wiLink
===============

If you retrieved the wiLink source code via git, make sure you grab the
necessary submodules using:

$ git submodule update --init

The basic procedure for building wiLink from source is:

./release

On Debian/Ubuntu
----------------

wiLink is shipped with information for generating Debian packages, you can
generate the Debian package for wiLink by running:

$ dpkg-buildpackage