README.md 2.34 KB
Newer Older
1 2 3 4 5 6
# Jami-qt

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

![jami-logo](images/logo-jami-standard-coul.png)

7

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

10 11
- Main website: https://jami.net/
- Bug tracker: https://git.jami.net/
12 13 14 15
- Repositories: https://gerrit-ring.savoirfairelinux.com

## Requirements

16
- Jami client library and Jami daemon
17 18 19 20 21 22
- Mingw-w64 build environment
- Qt5 (we link against Qt5Core, Qt5Widgets, Qt5Gui) built with Mingw
- Qt5 Svg, Qt5 ImageFormats & Qt5 WinExtras built with Mingw

## Get the source code

23
 - `git clone https://gerrit-ring.savoirfairelinux.com/ring-client-windows`
24 25 26

## Build instructions

27 28 29 30 31 32 33 34
**NOTE: The build process is currently under a full refactorization. This section will be updated soon**

## Windows

TBD

### Build winsparkle
In the client directory after having initialized the submodule:
35 36

```
37
cd winsparkle
38
mkdir build && cd build
39
cmake -DCMAKE_TOOLCHAIN_FILE=<LRC Directory>/cmake/winBuild.cmake -DCMAKE_INSTALL_PREFIX=Install dir of Jami and LRC> ../cmake",
40 41 42 43
make
make install
```

44
### Packaging
45 46 47 48 49 50 51

* Nsis : Nullsoft Scriptable Install System :http://nsis.sourceforge.net/Main_Page.

```
cd build/release
makensis ring.nsi
```
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90


## Linux

For now, this process is experimental. The best way to do that is:

1. Compile the daemon and LRC as specified in these projects (see the respective repositories or https://git.jami.net/savoirfairelinux/ring-project/wikis/technical/Build-instructions).
2. Install needed dependencies (TBD):
    + For Fedora:
```bash
sudo dnf install qt5-qtsvg-devel qt5-qtwebengine-devel qt5-multimedia-devel
```
3. If you are not using the `ring-project` repository, you have to define the `LRC` environment variable to contains the install directory for `LRC`. Also, you will have to setup `LD_LIBRARY_PATH` if your install directory is a custom one.
4. Then, build the client:

```bash
mkdir build
cd build
qmake-qt5 ../jami-qt.pro
make -j 9
```

5. Then, you are finally ready to launch `jami-qt` in your `build` directory.

### Known issues

1. The build system is not straight forward
2. Video doesn't work
3. Can't maximize/minimize window
4. Crash if the daemon is not started and installed.

## Mac OS

TBD


## Debugging

Compile the client with 'BUILD=Debug' and libRingClient with '-DCMAKE_BUILD_TYPE=Debug'