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 16.04
* Fedora 22 - Fedora 24

## 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](http://kcat.strangesoft.net/openal.html))
* 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))
* Open Sans font ([Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html))

## Build instructions

* [Visual Studio 2015][msvc]
* [Xcode 8][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)
-												Profile done as a new generic Window::SectionWidget.
Slide animation reimplemented.

											
										
										
											2016-05-19 12:03:51 +00:00
+								* Ubuntu 12.04 - Ubuntu 16.04
-												 Update README.md with a new supported OS (#2571)

* Update README.md with a new supported OS

Signed-off-by: MohammadReza Espargham <reza.espargham@owasp.org> (github: rezasp)

											
										
										
											2016-10-27 20:54:18 +00:00
+								* Fedora 22 - Fedora 24
-												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))
-												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
+								* 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 audio and voice messages

											
										
										
											2014-09-04 07:33:44 +00:00
+								* OpenAL Soft ([LGPL](http://kcat.strangesoft.net/openal.html))
-												instructions for building ffmpeg added

											
										
										
											2015-06-01 12:44:10 +00:00
+								* Opus codec ([BSD license](http://www.opus-codec.org/license/))
 								* 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))
-												Use mapbox::util::variant in a submodule.

While we don't have C++17 std::variant<> use a BSD licensed
alternative from mapbox team in a base:: wrapper.

											
										
										
											2017-03-10 14:06:10 +00:00
+								* Mapbox Variant ([BSD license](https://github.com/mapbox/variant/blob/master/LICENSE))
-												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))
-												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
-												moved to Qt 5.5.1, build docs for MSVC2015 and Xcode7 updated

											
										
										
											2015-10-19 21:24:39 +00:00
+								* [Visual Studio 2015][msvc]
-												SPMediaKeyTap solution for macOS media keys added.

											
										
										
											2016-10-17 14:57:14 +00:00
+								* [Xcode 8][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