Commit a1e68e07 authored by Ghislain MARY's avatar Ghislain MARY

Add the file to explain how to use the linphone-desktop project.

parent 65de220c
Linphone is a free VoIP and video softphone based on the SIP protocol.
![Dialer screenshot](
# Getting started
Here are the general instructions to build linphone for desktop. The specific instructions for each build platform is described just below.
1. Install some build tools: CMake, Python.
2. Prepare the build by running the script.
3. Build the project using the appropriate build tool (make, ninja, Xcode, Visual Studio).
## Specific instructions for the Linux platform
1. Prepare the build in a terminal by running the following command in the current directory:
2. Build the project in a terminal with:
## Specific instructions for the Windows platform
1. Open a Windows command line (cmd.exe) in the current directory and run:
2. Open the generated Visual Studio solution (WORK/cmake/Project.sln) and build it.
## Specific instructions for the Mac OS X platform
1. Open in the current directory and run:
2. Build the project with:
# Customizing your build
Some options can be given during the `` step to customize the build. The basic usage of the `` script is:
./ [options]
Here are the main options you can use.
## Building with debug symbols
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 ``:
./ --debug [other options]
## Generating an installation package (on Windows and Mac OS X platforms)
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:
./ --package [other options]
## Activate the build of all codecs
./ --all-codecs
## Using more advanced options
The `` script is wrapper around CMake. Therefore you can give any CMake option to the `` script.
To get a list of the options you can pass, you can run:
./ --list-cmake-variables
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:
# Updating your build
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).
However if the compilation fails, you may need to rebuild everything from scratch using:
./ -C && ./ [options]
Then you re-build as usual.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment