| 1 | ## Telegram messenger for Android |
| 2 | |
| 3 | [Telegram](https://telegram.org) is a messaging app with a focus on speed and security. It’s superfast, simple and free. |
| 4 | This repo contains the official source code for [Telegram App for Android](https://play.google.com/store/apps/details?id=org.telegram.messenger |
| 5 |
| 6 | ## Creating your Telegram Application |
| 7 |
| 8 | We welcome all developers to use our API and source code to create applications on our platform. |
| 9 | There are several things we require from **all developers** for the moment. |
| 10 |
| 11 | 1. [**Obtain your own api_id**](https://core.telegram.org/api/obtaining_api_id) for your application. |
| 12 | 2. Please **do not** use the name Telegram for your app — or make sure your users understand that it is unofficial. |
| 13 | 3. Kindly **do not** use our standard logo (white paper plane in a blue circle) as your app's logo. |
| 14 | 3. Please study our [**security guidelines**](https://core.telegram.org/mtproto/security_guidelines) and take good care of your users' data and privacy. |
| 15 | 4. Please remember to publish **your** code too in order to comply with the licences. |
| 16 |
| 17 | ### API, Protocol documentation |
| 18 |
| 19 | Telegram API manuals: https://core.telegram.org/api |
| 20 |
| 21 | MTproto protocol manuals: https://core.telegram.org/mtproto |
| 22 |
| 23 | ### Compilation Guide |
| 24 |
| 25 | **Note**: In order to support [reproducible builds](https://core.telegram.org/reproducible-builds), this repo contains dummy release.keystore, google-services.json and filled variables inside BuildVars.java. Before publishing your own APKs please make sure to replace all these files with your own. |
| 26 |
| 27 | You will require Android Studio 3.4, Android NDK rev. 20 and Android SDK 8.1 |
| 28 |
| 29 | 1. Download the Telegram source code from https://github.com/DrKLO/Telegram ( git clone https://github.com/DrKLO/Telegram.git ) |
| 30 | 2. Copy your release.keystore into TMessagesProj/config |
| 31 | 3. Fill out RELEASE_KEY_PASSWORD, RELEASE_KEY_ALIAS, RELEASE_STORE_PASSWORD in gradle.properties to access your release.keystore |
| 32 | 4. Go to https://console.firebase.google.com/, create two android apps with application IDs org.telegram.messenger and org.telegram.messenger.beta, turn on firebase messaging and download google-services.json, which should be copied to the same folder as TMessagesProj. |
| 33 | 5. Open the project in the Studio (note that it should be opened, NOT imported). |
| 34 | 6. Fill out values in TMessagesProj/src/main/java/org/telegram/messenger/BuildVars.java – there’s a link for each of the variables showing where and which data to obtain. |
| 35 | 7. You are ready to compile Telegram. |
| 36 |
| 37 | ### Localization |
| 38 |
| 39 | We moved all translations to https://translations.telegram.org/en/android/. Please use it. |
| 40 |