commit	e3417b8f37f41bbb262fa08e80bcd86caf87eb29	[log] [tgz]
author	Sébastien Blin <sebastien.blin@savoirfairelinux.com>	Sat Oct 10 13:32:06 2020 -0400
committer	Sébastien Blin <sebastien.blin@savoirfairelinux.com>	Sat Oct 10 13:32:06 2020 -0400
tree	c59c862c1b401fa0e9e05d24cf24b86dada70415
parent	cc3336277a3f9fe065ef93a4915b2adc0e987624 [diff]

tree: c59c862c1b401fa0e9e05d24cf24b86dada70415

README.md

Jami-qt

Share, freely and privately

Introduction

Jami provides all its users a universal communication tool, autonomous, free, secure and built on a distributed architecture thus requiring no authority or central server to function.

jami-qt is the cross platform client for Jami. For now, it's mainly used for the Windows platform and is not tested on other platforms.

For more information about the jami project, see the following:

Getting involved

Browse our current issues, or file an issue.
IRC: #jami on freenode
ML: jami@gnu.org
Documentation: https://docs.jami.net
Localization happens on Transifex
Our contributions propositions or feature requests asked by the community
Packaging: Feel free to contact us

Notes

Coding style is managed by the clang-format, if you want to contribute, please use the pre-commit hook automatically installed with ./make-ring.py --init
We use gerrit for our review. Please read https://git.jami.net/savoirfairelinux/ring-project/wikis/tutorials/Working-with-gerrit if you want to submit patches.

Build instructions

Note: This project is quite new, and still need some work for the build integration.

Dependencies

This client is only the graphical part, you will need to also build the daemon and LRC (the library containing the logic for desktop clients). Because of this, the recommended way is to clone our meta-repository containing all submodules needed.

In order to use the QML Client it is necessary to install the Qt version 5.15 or higher. You can install it from sources or download the binary installer.

Finally, pandoc is needed to generate the changelog page.

Build all projects

git clone https://review.jami.net/ring-project

Jami installer uses python3. If it's not installed, please install it:

cd ring-project/
./make-ring.py --init

Then you will need to install dependencies:

For GNU/Linux

./make-ring.py --dependencies # needs sudo

Then, you can build daemon, lrc and client-qt with:

./make-ring.py --install --qt

And you will have the daemon in daemon/bin/dring and the client in client-qt/build-local/jami-qt. You also can run it with

./make-ring.py --run --qt

Build only the client

cd client-qt
pandoc -f markdown -t html5 -o changelog.html changelog.md
mkdir build
cd build
${YOUR_QT5_gcc64_PATH}/bin/qmake /jami-qt.pro
make -j9

If you want more details, or separately build other projects you can check this page.

Building On Native Windows

Only 64-bit MSVC build can be compiled.

Note: command ./make-ring.py --init is not required on the Windows build

Setup Before Building:

Download Qt (Open Source)
Prebuild Module
Components: msvc2017_64 Qt WebEngine
Download Visual Studio (version >= 2015)
Install Qt Vs Tools under extensions, and configure msvc2017_64 path under Qt Options
Qt Version SDK Toolset
Minimum requirement: 5.9.4 10.0.16299.0 V141
Install Python3 for Windows

	Prebuild	Module
Components:	msvc2017_64	Qt WebEngine

	Qt Version	SDK	Toolset
Minimum requirement:	5.9.4	10.0.16299.0	V141

Start Building

Using Command Prompt

    git clone https://review.jami.net/ring-project
    cd ring-project/
    git submodule update --init daemon lrc client-windows
    git submodule update --recursive --remote daemon lrc client-windows

Using Elevated Command Prompt

    python make-ring.py --dependencies

Note:
This command will install chocolatey which may require you to restart the Command Prompt to be able to use it.
This command will install msys2 (64 bit) by using chocolatey command which may cause issues below:
a. Choco may require you to restart the Command Prompt after finishing installing msys2.
b. Only if you have already installed msys2 (64 bit) under the default installation folder, we will use the existing one.
This command will install strawberry perl by using chocolatey command which may fail if you have already installed it.
This command will install cmake by using chocolatey command which will not add cmake into PATH (environment variable).
The issue 1, 2(a), 3 can be solved by restarting the Command Prompt under Administrator right and re-run the command.
The issue 3 can be solved by uninstalling your current strawberry perl and re-run the command.
The issue 4 can be solved by adding the location of the cmake.exe into PATH.

Using a new Non-Elevated Command Prompt

    python make-ring.py --install

Then you should be able to use the Visual Studio Solution file in client-windows folder (Configuration = Release, Platform = x64)

Note:
To control the toolset and the sdk version that are used by msbuild, you can use --toolset and --sdk options
To control which Qt version should be used (qmake, windeployqt), uou can use --qtver option
By default: toolset=v141, sdk=10.0.16299.0, qtver=5.9.4
For example:

    python make-ring.py --install --toolset v142 --sdk 10.0.18362.0 --qtver 5.12.0

Build Module individually

Jami-qt also support building each module (daemon, lrc, jami-qt) seperately

Daemon

Make sure that dependencies is built by make-ring.py
On MSVC folder (ring-project\daemon\MSVC):

    cmake -DCMAKE_CONFIGURATION_TYPES="ReleaseLib_win32" -DCMAKE_VS_PLATFORM_NAME="x64" -G "Visual Studio 16 2019" -A x64 -T '$(DefaultPlatformToolset)' ..
    python winmake.py -b daemon

This will generate a .lib file in the path of ring-project\daemon\MSVC\x64\ReleaseLib_win32\bin

Note: each dependencies contrib for daemon can also be updated individually
For example:

    python winmake.py -b opendht

Lrc

Make sure that daemon is built first

    cd lrc
    python make-lrc.py -gb

Jami-qt

Make sure that daemon, lrc are built first

    cd client-windows
    pandoc -f markdown -t html5 -o changelog.html changelog.md
    python make-client.py -d
    python make-client.py -b
    powershell -ExecutionPolicy Unrestricted -File copy-runtime-files.ps1

Note

For all python scripts, both --toolset and --sdk options are available.
For more available options, run scripts with -h option.
--qtver option is available on make-lrc.py and make-client.py.

Packaging On Native Windows

To be able to generate a msi package, first download and install Wixtoolset.
In Visual Studio, download WiX Toolset Visual Studio Extension.
Build client-windows project first, then the JamiInstaller project, msi package should be stored in ring-project\client-windows\JamiInstaller\bin\Release

Debugging

Compile the client with BUILD=Debug and compile LibRingClient with -DCMAKE_BUILD_TYPE=Debug

License

Jami 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.

See COPYING or https://www.gnu.org/licenses/gpl-3.0.en.html for the full GPLv3 license.