Commit ac49ad25 authored by Ronan's avatar Ronan

chore(README.md): change title size

parent dda1fa23
......@@ -4,7 +4,7 @@
Linphone is a free VoIP and video softphone based on the SIP protocol.
# Getting started
## Getting started
Here are the general instructions to build linphone for desktop. The specific instructions for each build platform is described just below.
......@@ -20,7 +20,7 @@ Here are the general instructions to build linphone for desktop. The specific in
4. Prepare the build by running the `prepare.py` script.
5. Build the project using the appropriate build tool (`make`, `ninja`, `Xcode`, `Visual Studio (2013 or 2015 version)`).
## Specific instructions for the GNU/Linux and Mac OS X platforms
### Specific instructions for the GNU/Linux and Mac OS X platforms
1. Prepare the build in a terminal by running the following command in the current directory:
......@@ -30,7 +30,7 @@ Here are the general instructions to build linphone for desktop. The specific in
make
## Specific instructions for the Windows platform
### Specific instructions for the Windows platform
1. Open a Windows command line (cmd.exe) in the current directory and run:
......@@ -38,11 +38,11 @@ Here are the general instructions to build linphone for desktop. The specific in
2. Open the generated Visual Studio solution `Project.lnk` and build it.
# Known bugs and issues
## Known bugs and issues
* __4K (High DPI Displays)__ If you encounter troubles with high DPI displays, it can be useful to set the `QT_AUTO_SCREEN_SCALE_FACTOR` environment variable to 1.
# Customizing your build
## Customizing your build
Some options can be given during the `prepare.py` step to customize the build. The basic usage of the `prepare.py` script is:
......@@ -50,23 +50,23 @@ Some options can be given during the `prepare.py` step to customize the build. T
Here are the main options you can use.
## Building with debug symbols
### 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 `prepare.py`:
./prepare.py --debug [other options]
## Generating an installation package (on Windows and Mac OS X platforms)
### 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:
./prepare.py --package [other options]
## Activate the build of all codecs
### Activate the build of all codecs
./prepare.py --all-codecs
## Using more advanced options
### Using more advanced options
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:
......@@ -77,7 +77,7 @@ The options that enable you to configure what will be built are the ones beginni
./prepare.py -DENABLE_OPUS=NO
# Updating your build
## 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:
......
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