tdesktop/README.md

67 lines
3.8 KiB
Markdown
Raw Normal View History

# [Telegram Desktop][telegram_desktop] Official Messenger
2014-05-02 14:36:31 +02: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.
2017-02-01 12:24:59 +01:00
[![Version](https://badge.fury.io/gh/telegramdesktop%2Ftdesktop.svg)](https://github.com/telegramdesktop/tdesktop/releases)
[![Build Status](https://github.com/telegramdesktop/tdesktop/workflows/Windows./badge.svg)](https://github.com/telegramdesktop/tdesktop/actions)
[![Build Status](https://github.com/telegramdesktop/tdesktop/workflows/MacOS./badge.svg)](https://github.com/telegramdesktop/tdesktop/actions)
[![Build Status](https://github.com/telegramdesktop/tdesktop/workflows/Linux./badge.svg)](https://github.com/telegramdesktop/tdesktop/actions)
2017-04-04 14:50:01 +02:00
[![Preview of Telegram Desktop][preview_image]][preview_image_url]
2017-04-04 14:45:42 +02:00
2015-10-03 13:34:56 +02:00
The source code is published under GPLv3 with OpenSSL exception, the license is available [here][license].
2014-05-30 12:09:53 +02:00
## Supported systems
* Windows XP - Windows 10 (**not** RT)
2019-10-18 19:36:03 +02:00
* Mac OS X 10.8 - Mac OS X 10.15
2015-08-01 14:56:10 +02:00
* Mac OS X 10.6 - Mac OS X 10.7 (separate build)
2020-04-25 11:05:44 +02:00
* Ubuntu 12.04 - Ubuntu 20.04
2019-12-29 16:41:27 +01:00
* Fedora 22 - Fedora 31
* [Snappy](https://snapcraft.io/telegram-desktop)
2019-05-10 11:38:46 +02:00
* [Flathub](https://flathub.org/apps/details/org.telegram.desktop)
## Third-party
2014-06-17 07:37:53 +02:00
2020-03-01 12:38:25 +01:00
* Qt 5.12.8 and 5.6.2, slightly patched ([LGPL](http://doc.qt.io/qt-5/lgpl.html))
2019-12-18 01:33:03 +01:00
* OpenSSL 1.1.1 ([OpenSSL License](https://www.openssl.org/source/license.html))
* zlib 1.2.11 ([zlib License](http://www.zlib.net/zlib_license.html))
2014-06-17 07:37:53 +02:00
* LZMA SDK 9.20 ([public domain](http://www.7-zip.org/sdk.html))
* liblzma ([public domain](http://tukaani.org/xz/))
2016-02-04 13:44:39 +01: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))
* 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/))
2015-06-01 14:44:10 +02:00
* 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))
2017-11-19 15:37:07 +01:00
* Range-v3 ([Boost License](https://github.com/ericniebler/range-v3/blob/master/LICENSE.txt))
2015-10-03 13:34:56 +02:00
* 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))
2018-07-30 20:30:26 +02:00
* xxHash ([BSD License](https://github.com/Cyan4973/xxHash/blob/dev/LICENSE))
2019-12-06 09:39:13 +01:00
* QR Code generator ([MIT License](https://github.com/nayuki/QR-Code-generator#license))
2019-12-18 01:33:03 +01:00
* CMake ([New BSD License](https://github.com/Kitware/CMake/blob/master/Copyright.txt))
* Hunspell ([GPL](https://github.com/hunspell/hunspell/blob/master/COPYING))
## Build instructions
* [Visual Studio 2019][msvc]
* [Xcode 11][xcode]
* [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
2017-04-04 14:40:49 +02:00
[msvc]: docs/building-msvc.md
[xcode]: docs/building-xcode.md
[xcode_old]: docs/building-xcode-old.md
[cmake]: docs/building-cmake.md
2017-04-04 14:45:42 +02:00
[preview_image]: https://github.com/telegramdesktop/tdesktop/blob/dev/docs/assets/preview.png "Preview of Telegram Desktop"
2017-04-04 14:50:01 +02:00
[preview_image_url]: https://raw.githubusercontent.com/telegramdesktop/tdesktop/dev/docs/assets/preview.png