README.md 5.25 KB
Newer Older
Erwan Croze's avatar
Erwan Croze committed
1 2
[![pipeline status](https://gitlab.linphone.org/BC/public/linphone-desktop/badges/master/pipeline.svg)](https://gitlab.linphone.org/BC/public/linphone-desktop/commits/master)

Ronan's avatar
Ronan committed
3
# Linphone Desktop
4

5
![screenshot](readme_screen.png)
6

Ronan's avatar
Ronan committed
7 8
Linphone is a free VoIP and video softphone based on the SIP protocol.

9
## Getting started
10 11 12

Here are the general instructions to build linphone for desktop. The specific instructions for each build platform is described just below.

13
1. Install some build tools: `CMake`, `Python` and `Qt5` (_5.9 or newer_). `C++11` support is required!
Ronan's avatar
Ronan committed
14
2. It's necessary to set the environment variable `Qt5_DIR` to point to the path containing the cmake folders of Qt5. Example:
15

16
        Qt5_DIR="~/Qt/5.9/gcc_64/lib/cmake"
Ronan's avatar
Ronan committed
17 18 19

3. The `PATH` environment variable must point to the Qt5 directory `bin`. Example:

Ronan's avatar
Ronan committed
20
        PATH="~/Qt/5.9/gcc_64/bin/:$PATH"
Ronan's avatar
Ronan committed
21

Ronan's avatar
Ronan committed
22
4. Prepare the build by running the `prepare.py` script.
Ronan's avatar
Ronan committed
23 24
5. Build the project using the appropriate build tool (`make`, `ninja`, `Xcode`, `Visual Studio (2013 or 2015 version)`).

25
### Specific instructions for the GNU/Linux and Mac OS X platforms
26 27

1. Prepare the build in a terminal by running the following command in the current directory:
Ronan's avatar
Ronan committed
28

29
        ./prepare.py -DENABLE_DOC=OFF
Ronan's avatar
Ronan committed
30

31
2. Build the project in a terminal with:
Ronan's avatar
Ronan committed
32

33 34
        make

35 36 37 38
#### Mac OS X Troubleshooting
To install the required dependencies on Mac OS X, you can use [Homebrew](https://brew.sh/).
Before you install packages with Brew, you may have to change directories permissions (if you can't change permissions with sudo on a MacOS >= High Sierra, get a look at [this StackOverflow answer](https://stackoverflow.com/questions/16432071/how-to-fix-homebrew-permissions#46844441)).

39
1. First ensure you have installed pip. You can get it for python 2.7 [there](https://stackoverflow.com/questions/34886101/how-to-install-pip-to-python-2-7-10-on-mac#34886254).
40

41
2. Then, you can install a pip package with the following command:
42 43 44

        pip install [package]

45
    For instance, if you don't have pystache and the dot package (contained in graphviz), enter the following commands:
46 47 48 49

        pip install pystache
        pip install graphviz

50
3. Finish the pre-build by cleaning the obsolete files and then run prepare.py and make again:
51 52 53 54 55

        ./prepare.py -c
        ./prepare.py -DENABLE_DOC=OFF
        make

56
### Specific instructions for the Windows platform
57

58
1. Ensure that you have downloaded the `Qt msvc2015 version` (32-bit). (64-bit version is not supported at this moment by Linphone Desktop.) `MinGW` must be installed too.
59

60 61 62
2. Define the `Qt5_DIR` and `PATH` environment variable to the Qt5 installation path:

        Qt5_DIR="C:\Qt\5.9\msvc2015\lib\cmake"
63
        PATH="C:\Qt\5.9\msvc2015\bin;%PATH%"
64 65

3. Open a Windows command line (cmd.exe) in the current directory and run:
66

67
        python prepare.py -G "Visual Studio 14 2015" -DENABLE_DOC=OFF
68

69
4. Open the generated Visual Studio solution `Project.sln.lnk` and build it. Check if the `Release` option is selected in Visual Studio. (With `Win32`!)
70

71
## Known bugs and issues
72

73
* __4K (High DPI Displays)__ If you encounter troubles with high DPI displays on Windows, please to see this link: https://bugreports.qt.io/browse/QTBUG-53022
74

75
## Customizing your build
76 77 78 79 80 81 82

Some options can be given during the `prepare.py` step to customize the build. The basic usage of the `prepare.py` script is:

        ./prepare.py [options]

Here are the main options you can use.

83
### Building with debug symbols
84 85 86 87 88

Building with debug symbols is necessary if you want to be able to debug the application using some tools like GDB or the Visual Studio debugger. To do so, pass the `--debug` option to `prepare.py`:

        ./prepare.py --debug [other options]

89
### Generating an installation package (on Windows and Mac OS X platforms)
90 91 92 93 94

You might want to generate an installation package to ease the distribution of the application. To add the package generation step to the build just run:

        ./prepare.py --package [other options]

95
### Activate the build of all codecs
96 97 98

        ./prepare.py --all-codecs

99
### Using more advanced options
100 101 102 103 104 105

The `prepare.py` script is wrapper around CMake. Therefore you can give any CMake option to the `prepare.py` script.
To get a list of the options you can pass, you can run:

        ./prepare.py --list-cmake-variables

Ronan's avatar
Ronan committed
106
The options that enable you to configure what will be built are the ones beginning with `ENABLE_`. So for example, you might want to build linphone without the opus codec support. To do so use:
107 108 109

        ./prepare.py -DENABLE_OPUS=NO

110
## Updating your build
111

112 113 114 115 116 117
You need to update the project:

      git pull --rebase
      git submodule sync && git submodule update --init --recursive

Then simply re-building using the appropriate tool corresponding to your platform (make, Visual Studio...) should be sufficient to update the build (after having updated the source code via git).
118 119
However if the compilation fails, you may need to rebuild everything from scratch using:

Ronan's avatar
Ronan committed
120
        ./prepare.py -c && ./prepare.py [options]
121 122

Then you re-build as usual.
123

124 125 126 127 128 129 130
## Contributing

### Languages

Linphone is getting a full internationalization support, using Transifex platform.
If you want you can contribute at: https://www.transifex.com/belledonne-communications/linphone-desktop/languages/

131 132 133
## License

GPLv2 © [Linphone](https://linphone.org)