diff --git a/README.md b/README.md index 1b4b41452..0003c9ba2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -## [Telegram Desktop](https://tdesktop.com) – Official Telegram Messenger app +# [Telegram Desktop][telegram_desktop] – Official Messenger -This is complete source code and build instructions for alpha version of official desktop client for [Telegram](https://telegram.org) messenger, based on [Telegram API](https://core.telegram.org/) and [MTProto](https://core.telegram.org/mtproto) secure protocol. +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. -Source code is published under GPL v3, license is available [here](https://github.com/telegramdesktop/tdesktop/blob/master/LICENSE). +The source code is published under GPL v3, the license is available [here][license]. -###Supported systems +## Supported systems * Windows XP - Windows 10 (**not** RT) * Mac OS X 10.8 - Mac OS X 10.10 @@ -12,9 +12,9 @@ Source code is published under GPL v3, license is available [here](https://githu * Ubuntu 12.04 - Ubuntu 14.04 * Fedora 22 -###Third-party +## Third-party libraries -* Qt 5.3.2 and 5.5.0, slightly patched ([LGPL](http://qt-project.org/doc/qt-5/lgpl.html)) +* Qt 5.3.2 and 5.5.0, slightly patched ([LGPL](http://doc.qt.io/qt-5/licensing.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)) @@ -25,75 +25,84 @@ Source code is published under GPL v3, license is available [here](https://githu * FFmpeg ([LGPL](https://www.ffmpeg.org/legal.html)) * Open Sans font ([Apache License](http://www.apache.org/licenses/LICENSE-2.0.html)) -###[Build instructions for Visual Studio 2013](https://github.com/telegramdesktop/tdesktop/blob/master/MSVC.md) +## Build instructions -###[Build instructions for XCode 6.4](https://github.com/telegramdesktop/tdesktop/blob/master/XCODE.md) +* [Visual Studio 2013][msvc] +* [XCode 6.4][xcode] +* [XCode 6.4 for OS X 10.6 and 10.7][xcode_old] +* [Qt Creator 3.2.0 Ubuntu][qtcreator] -###[Build instructions for XCode 6.4 for OS X 10.6 and 10.7](https://github.com/telegramdesktop/tdesktop/blob/master/XCODEold.md) +## Projects in Telegram solution -###[Build instructions for Qt Creator 3.2.0 Ubuntu](https://github.com/telegramdesktop/tdesktop/blob/master/QTCREATOR.md) +* ### Telegram -##Projects in Telegram solution + [Telegram Desktop][telegram_desktop] messenger -####Telegram +* ### Updater -tdesktop messenger + A little app, that is launched by Telegram when update is ready, replaces all files and launches it back. -####Updater +* ### Packer -little app, that is launched by Telegram when update is ready, replaces all files and launches it back + Compiles given files to single update file, compresses it with lzma and signs with a private key. It is not built in **Debug** and **Release** configurations of Telegram solution, because private key is inaccessible. -####Packer +* ### Prepare -compiles given files to single update file, compresses it with lzma and signs with a private key, it is not built in **Debug** and **Release** configurations of Telegram solution, because private key is inaccessible + Prepares a release for deployment, puts all current files to deploy/{version} folder. -####Prepare + **Windows**: + * tsetup{version}.exe installer + * Telegram.exe + * Telegram.pdb (debug info for crash minidumps view) + * tupdate{updversion} binary lzma update archive -prepares a release for deployment, puts all files to deploy/{version} folder, for Win: -* current tsetup{version}exe installer -* current Telegram.exe -* current Telegram.pdb (debug info for crash minidumps view) -* current tupdate{updversion} binary lzma update archive + **Mac**: + * tsetup{version}.dmg + * Telegram.app + * tmacupd{updversion} binary lzma update archive -for Mac: -* current tsetup{version}dmg -* current Telegram.app -* current tmacupd{updversion} binary lzma update archive +* ### MetaEmoji -####MetaEmoji + Creates four sprites and text2emoji replace code + * SourceFiles/art/emoji.png + * SourceFiles/art/emoji_125x.png + * SourceFiles/art/emoji_150x.png + * SourceFiles/art/emoji_200x.png + * SourceFiles/art/emoji_250x.png + * SourceFiles/gui/emoji_config.cpp -creates four sprites and text2emoji replace code -* SourceFiles/art/emoji.png -* SourceFiles/art/emoji_125x.png -* SourceFiles/art/emoji_150x.png -* SourceFiles/art/emoji_200x.png -* SourceFiles/art/emoji_250x.png -* SourceFiles/gui/emoji_config.cpp +* ### MetaStyle -####MetaStyle + From two files and two sprites + * Resources/style_classes.txt + * Resources/style.txt + * SourceFiles/art/sprite.png + * SourceFiles/art/sprite_200x.png -from two files and two sprites -* Resources/style_classes.txt -* Resources/style.txt -* SourceFiles/art/sprite.png -* SourceFiles/art/sprite_200x.png + Creates two other sprites, four sprite grids and style constants code + * SourceFiles/art/sprite_125x.png + * SourceFiles/art/sprite_150x.png + * SourceFiles/art/grid.png + * SourceFiles/art/grid_125x.png + * SourceFiles/art/grid_150x.png + * SourceFiles/art/grid_200x.png + * GeneratedFiles/style_classes.h + * GeneratedFiles/style_auto.h + * GeneratedFiles/style_auto.cpp -creates two other sprites, four sprite grids and style constants code -* SourceFiles/art/sprite_125x.png -* SourceFiles/art/sprite_150x.png -* SourceFiles/art/grid.png -* SourceFiles/art/grid_125x.png -* SourceFiles/art/grid_150x.png -* SourceFiles/art/grid_200x.png -* GeneratedFiles/style_classes.h -* GeneratedFiles/style_auto.h -* GeneratedFiles/style_auto.cpp +* ### MetaLang -####MetaLang + Creates from languagepack file `Resources/lang.txt` language constants code and language file parse code: + * GeneratedFiles/lang.h + * GeneratedFiles/lang.cpp -from langpack file -* Resources/lang.txt - -creates lang constants code and lang file parse code -* GeneratedFiles/lang.h -* GeneratedFiles/lang.cpp +[//]: # (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]: MSVC.md +[xcode]: XCODE.md +[xcode_old]: XCODEold.md +[qtcreator]: qtcreator.md \ No newline at end of file