tdesktop/README.md

# [Telegram Desktop][telegram_desktop] – Official Messenger

This is the complete source code and the build instructions for the alpha version of the official desktop client for the [Telegram][telegram] messenger, based on the [Telegram API][telegram_api] and the [MTProto][telegram_proto] secure protocol.

[![Version](https://badge.fury.io/gh/telegramdesktop%2Ftdesktop.svg)](https://github.com/telegramdesktop/tdesktop/releases)
[![Build Status](https://travis-ci.org/telegramdesktop/tdesktop.svg?branch=dev)](https://travis-ci.org/telegramdesktop/tdesktop)
[![Build status](https://ci.appveyor.com/api/projects/status/uiw2y768iy4i5bu8/branch/dev?svg=true)](https://ci.appveyor.com/project/telegramdesktop/tdesktop)

[![Preview of Telegram Desktop][preview_image]][preview_image_url]

The source code is published under GPLv3 with OpenSSL exception, the license is available [here][license].

## Supported systems

* Windows XP - Windows 10 (**not** RT)
* Mac OS X 10.8 - Mac OS X 10.11
* Mac OS X 10.6 - Mac OS X 10.7 (separate build)
* Ubuntu 12.04 - Ubuntu 18.10
* Fedora 22 - Fedora 29
* [Snappy](https://snapcraft.io/telegram-desktop)

## Third-party

* Qt 5.3.2 and 5.6.2, slightly patched ([LGPL](http://doc.qt.io/qt-5/lgpl.html))
* OpenSSL 1.0.1g ([OpenSSL License](https://www.openssl.org/source/license.html))
* zlib 1.2.8 ([zlib License](http://www.zlib.net/zlib_license.html))
* libexif 0.6.20 ([LGPL](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html))
* LZMA SDK 9.20 ([public domain](http://www.7-zip.org/sdk.html))
* liblzma ([public domain](http://tukaani.org/xz/))
* Google Breakpad ([License](https://chromium.googlesource.com/breakpad/breakpad/+/master/LICENSE))
* Google Crashpad ([Apache License 2.0](https://chromium.googlesource.com/crashpad/crashpad/+/master/LICENSE))
* GYP ([BSD License](https://github.com/bnoordhuis/gyp/blob/master/LICENSE))
* Ninja ([Apache License 2.0](https://github.com/ninja-build/ninja/blob/master/COPYING))
* OpenAL Soft ([LGPL](https://github.com/kcat/openal-soft/blob/master/COPYING))
* Opus codec ([BSD License](http://www.opus-codec.org/license/))
* FFmpeg ([LGPL](https://www.ffmpeg.org/legal.html))
* Guideline Support Library ([MIT License](https://github.com/Microsoft/GSL/blob/master/LICENSE))
* Mapbox Variant ([BSD License](https://github.com/mapbox/variant/blob/master/LICENSE))
* Range-v3 ([Boost License](https://github.com/ericniebler/range-v3/blob/master/LICENSE.txt))
* Open Sans font ([Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html))
* Emoji alpha codes ([MIT License](https://github.com/emojione/emojione/blob/master/extras/alpha-codes/LICENSE.md))
* Catch test framework ([Boost License](https://github.com/philsquared/Catch/blob/master/LICENSE.txt))
* xxHash ([BSD License](https://github.com/Cyan4973/xxHash/blob/dev/LICENSE))

## Build instructions

* [Visual Studio 2017][msvc]
* [Xcode 10][xcode]
* [GYP/CMake on GNU/Linux][cmake]

[//]: # (LINKS)
[telegram]: https://telegram.org
[telegram_desktop]: https://desktop.telegram.org
[telegram_api]: https://core.telegram.org
[telegram_proto]: https://core.telegram.org/mtproto
[license]: LICENSE
[msvc]: docs/building-msvc.md
[xcode]: docs/building-xcode.md
[xcode_old]: docs/building-xcode-old.md
[cmake]: docs/building-cmake.md
[preview_image]: https://github.com/telegramdesktop/tdesktop/blob/dev/docs/assets/preview.png "Preview of Telegram Desktop"
[preview_image_url]: https://raw.githubusercontent.com/telegramdesktop/tdesktop/dev/docs/assets/preview.png
-												Style updates
* List for "Projects in Telegram solution"

											
										
										
											2015-09-06 16:17:03 +00:00
+								# [Telegram Desktop][telegram_desktop] – Official Messenger
-												Initial commit

											
										
										
											2014-05-02 12:36:31 +00:00
-												Style updates
* List for "Projects in Telegram solution"

											
										
										
											2015-09-06 16:17:03 +00:00
+								This is the complete source code and the build instructions for the alpha version of the official desktop client for the [Telegram][telegram] messenger, based on the [Telegram API][telegram_api] and the [MTProto][telegram_proto] secure protocol.
-												initial commit for 0.4.18 version of Telegram Desktop

											
										
										
											2014-05-30 08:53:19 +00:00
-												Update version badge
											
										
										
											2017-02-01 11:24:59 +00:00
+								[![Version](https://badge.fury.io/gh/telegramdesktop%2Ftdesktop.svg)](https://github.com/telegramdesktop/tdesktop/releases)
-												Changed build status to reflect dev branch.

Default github branch now is dev, so is the build status in README.

											
										
										
											2017-03-01 18:59:16 +00:00
+								[![Build Status](https://travis-ci.org/telegramdesktop/tdesktop.svg?branch=dev)](https://travis-ci.org/telegramdesktop/tdesktop)
 								[![Build status](https://ci.appveyor.com/api/projects/status/uiw2y768iy4i5bu8/branch/dev?svg=true)](https://ci.appveyor.com/project/telegramdesktop/tdesktop)
-												Add build status badge to readme

Signed-off-by: Christoph Auer <auer.chrisi@gmx.net>

											
										
										
											2016-03-18 20:06:16 +00:00
-												Link to image

											
										
										
											2017-04-04 12:50:01 +00:00
+								[![Preview of Telegram Desktop][preview_image]][preview_image_url]
-												Add preview image to readme

											
										
										
											2017-04-04 12:45:42 +00:00
-												license openssl exception added

											
										
										
											2015-10-03 11:34:56 +00:00
+								The source code is published under GPLv3 with OpenSSL exception, the license is available [here][license].
-												License link added to README
											
										
										
											2014-05-30 10:09:53 +00:00
-												Updating README.md
Fixed style and small typos

											
										
										
											2015-09-04 14:26:34 +00:00
+								## Supported systems
-												initial commit for 0.4.18 version of Telegram Desktop

											
										
										
											2014-05-30 08:53:19 +00:00
-												added fcitx inputcontext plugin for linux version

											
										
										
											2015-08-13 15:09:04 +00:00
+								* Windows XP - Windows 10 (**not** RT)
-												langs updated, supported systems updated

											
										
										
											2016-03-25 16:43:14 +00:00
+								* Mac OS X 10.8 - Mac OS X 10.11
-												instructions updated

											
										
										
											2015-08-01 12:56:10 +00:00
+								* Mac OS X 10.6 - Mac OS X 10.7 (separate build)
-												Update Ubuntu support version (#5372)


											
										
										
											2018-12-26 12:09:20 +00:00
+								* Ubuntu 12.04 - Ubuntu 18.10
-												Update supported Fedora version (#5502)


											
										
										
											2018-12-24 13:03:40 +00:00
+								* Fedora 22 - Fedora 29
-												Update README.md (#5144): Add snapcraft


											
										
										
											2018-09-06 11:19:42 +00:00
+								* [Snappy](https://snapcraft.io/telegram-desktop)
-												initial commit for 0.4.18 version of Telegram Desktop

											
										
										
											2014-05-30 08:53:19 +00:00
-												Alpha version 0.10.2: first GYP/Ninja build, some bug and crash fixes.

Counting round radius dynamically to work fine with all font sizes.
Added GYP and Ninja to Third-party section. Fix of build script.

											
										
										
											2016-08-14 19:56:26 +00:00
+								## Third-party
-												app font changed to open sans

											
										
										
											2014-06-17 05:37:53 +00:00
-												Changed docs to work with Qt 5.6.2, hopefully fixed travis build.

											
										
										
											2016-10-17 21:33:24 +00:00
+								* Qt 5.3.2 and 5.6.2, slightly patched ([LGPL](http://doc.qt.io/qt-5/lgpl.html))
-												app font changed to open sans

											
										
										
											2014-06-17 05:37:53 +00:00
+								* OpenSSL 1.0.1g ([OpenSSL License](https://www.openssl.org/source/license.html))
 								* zlib 1.2.8 ([zlib License](http://www.zlib.net/zlib_license.html))
 								* libexif 0.6.20 ([LGPL](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html))
 								* LZMA SDK 9.20 ([public domain](http://www.7-zip.org/sdk.html))
-												build instructions done for os x version

											
										
										
											2014-06-25 20:15:34 +00:00
+								* liblzma ([public domain](http://tukaani.org/xz/))
-												langs updated, build scripts updated

											
										
										
											2016-02-04 12:44:39 +00:00
+								* Google Breakpad ([License](https://chromium.googlesource.com/breakpad/breakpad/+/master/LICENSE))
 								* Google Crashpad ([Apache License 2.0](https://chromium.googlesource.com/crashpad/crashpad/+/master/LICENSE))
-												Add emoji autocomplete data and algorithm.

											
										
										
											2017-07-19 18:37:49 +00:00
+								* GYP ([BSD License](https://github.com/bnoordhuis/gyp/blob/master/LICENSE))
-												Alpha version 0.10.2: first GYP/Ninja build, some bug and crash fixes.

Counting round radius dynamically to work fine with all font sizes.
Added GYP and Ninja to Third-party section. Fix of build script.

											
										
										
											2016-08-14 19:56:26 +00:00
+								* Ninja ([Apache License 2.0](https://github.com/ninja-build/ninja/blob/master/COPYING))
-												OpenAL soft license link update (#5379)


											
										
										
											2018-11-12 19:42:37 +00:00
+								* OpenAL Soft ([LGPL](https://github.com/kcat/openal-soft/blob/master/COPYING))
-												Add emoji autocomplete data and algorithm.

											
										
										
											2017-07-19 18:37:49 +00:00
+								* Opus codec ([BSD License](http://www.opus-codec.org/license/))
-												instructions for building ffmpeg added

											
										
										
											2015-06-01 12:44:10 +00:00
+								* FFmpeg ([LGPL](https://www.ffmpeg.org/legal.html))
-												Added Guideline Support Library as a dependency.

See https://github.com/Microsoft/GSL for information.

											
										
										
											2017-03-04 08:59:10 +00:00
+								* Guideline Support Library ([MIT License](https://github.com/Microsoft/GSL/blob/master/LICENSE))
-												Add emoji autocomplete data and algorithm.

											
										
										
											2017-07-19 18:37:49 +00:00
+								* Mapbox Variant ([BSD License](https://github.com/mapbox/variant/blob/master/LICENSE))
-												Add range-v3 library.

											
										
										
											2017-11-19 14:37:07 +00:00
+								* Range-v3 ([Boost License](https://github.com/ericniebler/range-v3/blob/master/LICENSE.txt))
-												license openssl exception added

											
										
										
											2015-10-03 11:34:56 +00:00
+								* Open Sans font ([Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html))
-												Add emoji autocomplete data and algorithm.

											
										
										
											2017-07-19 18:37:49 +00:00
+								* Emoji alpha codes ([MIT License](https://github.com/emojione/emojione/blob/master/extras/alpha-codes/LICENSE.md))
-												Add Catch unittest framework and some tests.

											
										
										
											2017-08-30 17:36:12 +00:00
+								* Catch test framework ([Boost License](https://github.com/philsquared/Catch/blob/master/LICENSE.txt))
-												Add xxHash library for checksums.

											
										
										
											2018-07-30 18:30:26 +00:00
+								* xxHash ([BSD License](https://github.com/Cyan4973/xxHash/blob/dev/LICENSE))
-												initial commit for 0.4.18 version of Telegram Desktop

											
										
										
											2014-05-30 08:53:19 +00:00
-												Updating README.md
Fixed style and small typos

											
										
										
											2015-09-04 14:26:34 +00:00
+								## Build instructions
-												initial commit for 0.4.18 version of Telegram Desktop

											
										
										
											2014-05-30 08:53:19 +00:00
-												Update build docs for VS 2017.

Closes #3117. Closes #3729.

											
										
										
											2017-09-06 09:12:27 +00:00
+								* [Visual Studio 2017][msvc]
-												Update instructions for Xcode 10.1.

											
										
										
											2019-01-05 12:34:34 +00:00
+								* [Xcode 10][xcode]
-												Moved all builds to GYP.

											
										
										
											2016-09-12 11:45:41 +00:00
+								* [GYP/CMake on GNU/Linux][cmake]
-												initial commit for 0.4.18 version of Telegram Desktop

											
										
										
											2014-05-30 08:53:19 +00:00
-												Updating README.md
Fixed style and small typos

											
										
										
											2015-09-04 14:26:34 +00:00
+								[//]: # (LINKS)
 								[telegram]: https://telegram.org
 								[telegram_desktop]: https://desktop.telegram.org
 								[telegram_api]: https://core.telegram.org
 								[telegram_proto]: https://core.telegram.org/mtproto
 								[license]: LICENSE
-												Rename doc to docs

											
										
										
											2017-04-04 12:40:49 +00:00
+								[msvc]: docs/building-msvc.md
 								[xcode]: docs/building-xcode.md
 								[xcode_old]: docs/building-xcode-old.md
 								[cmake]: docs/building-cmake.md
-												Add preview image to readme

											
										
										
											2017-04-04 12:45:42 +00:00
+								[preview_image]: https://github.com/telegramdesktop/tdesktop/blob/dev/docs/assets/preview.png "Preview of Telegram Desktop"
-												Link to image

											
										
										
											2017-04-04 12:50:01 +00:00
+								[preview_image_url]: https://raw.githubusercontent.com/telegramdesktop/tdesktop/dev/docs/assets/preview.png