RepoMirrors
/
tdesktop
mirror of https://github.com/telegramdesktop/tdesktop
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
tdesktop/docs/building-win.md

74 lines
4.2 KiB
Markdown
Raw Normal View History

Remove old instructions & patches they referred to (& rename instructions to the actual state) Old instruction names were from the time when tdesktop used GYP that had MSVC, XCode and CMake backends. But tdesktop uses CMake now, so these names are no longer correct.
2021-07-20 02:41:11 +00:00
# Build instructions for Windows
Improve build instructions for MSVC 2015 [ci skip] Add TOC Fix breakpad install Fix #2211 Signed-off-by: Christoph <auer.chrisi@gmx.net>
2016-07-03 13:17:22 +00:00
Fix breakpad installation on windows
2017-02-16 10:57:53 +00:00
- [Prepare folder](#prepare-folder)
Update build docs for VS 2017. Closes #3117. Closes #3729.
2017-09-06 09:12:27 +00:00
- [Install third party software](#install-third-party-software)
- [Clone source code and prepare libraries](#clone-source-code-and-prepare-libraries)
- [Build the project](#build-the-project)
- [Qt Visual Studio Tools](#qt-visual-studio-tools)
Improve build instructions for MSVC 2015 [ci skip] Add TOC Fix breakpad install Fix #2211 Signed-off-by: Christoph <auer.chrisi@gmx.net>
2016-07-03 13:17:22 +00:00
## Prepare folder
build instructions done for os x version
2014-06-25 20:15:34 +00:00
Use VS 2022 with 10.0.22000.0 SDK version.
2021-11-26 14:13:58 +00:00
The build is done in **Visual Studio 2022** with **10.0.22000.0** SDK version.
Move build to Ubuntu 14.04 and GCC 7.2. To be able to run on the same distributions as before we need to have the same GLIBC version dependency as in Ubuntu 12.04, which is 2.15. For that we need to remove all usages of GLIBC features from 2.16 and above. Currently there are three methods used, so they're wrapped in a separate static library, linux_glibc_wraps. It is a separate library because it must be compiled without '-flto' flag, otherwise the inline __asm__ is not working and we get unresolved symbols.
2017-09-28 09:40:26 +00:00
Choose an empty folder for the future build, for example **D:\\TBuild**. It will be named ***BuildPath*** in the rest of this document. Create two folders there, ***BuildPath*\\ThirdParty** and ***BuildPath*\\Libraries**.
Removed some download-in-ZIP from build docs.
2016-10-11 09:56:51 +00:00
Use VS 2022 with 10.0.22000.0 SDK version.
2021-11-26 14:13:58 +00:00
All commands (if not stated otherwise) will be launched from **x86 Native Tools Command Prompt for VS 2022.bat** (should be in **Start Menu > Visual Studio 2022** menu folder). Pay attention not to use any other Command Prompt.
build instructions done for os x version
2014-06-25 20:15:34 +00:00
Don't provide 'api_id' and 'api_hash' by default. We ask the developer to obtain his own api credentials, because the bundled 'api_id' / 'api_hash' are strictly limited by the server. The old credentials still could be used for test purposes, but the developer will need to explicitly opt-in to use them.
2018-11-04 10:29:30 +00:00
### Obtain your API credentials
You will require **api_id** and **api_hash** to access the Telegram API servers. To learn how to obtain them [click here][api_credentials].
Update build docs for VS 2017. Closes #3117. Closes #3729.
2017-09-06 09:12:27 +00:00
## Install third party software
Update building-msvc.md (#3264) * Update building-msvc.md Fixed some wrong, missing or unclear parts. Based on the problems I came into when trying to build and configure everything. Ninja not in path - from #3237 Newer msys - from #3247 Telegram.sln - from #2811 * Updated from the PR comments and added a signature Signed-off-by: Ariel Jannai <arieljannai@gmail.com> (github: arieljannai) * Updated by the latest comments from the PR Signed-off-by: Ariel Jannai <arieljannai@gmail.com> (github: arieljannai)
2017-04-14 09:58:10 +00:00
Use Strawberry Perl instead of Active Perl.
2020-01-03 08:41:38 +00:00
* Download **Strawberry Perl** installer from [http://strawberryperl.com/](http://strawberryperl.com/) and install to ***BuildPath*\\ThirdParty\\Strawberry**
Update build docs for VS 2017. Closes #3117. Closes #3729.
2017-09-06 09:12:27 +00:00
* Download **NASM** installer from [http://www.nasm.us](http://www.nasm.us) and install to ***BuildPath*\\ThirdParty\\NASM**
* Download **Yasm** executable from [http://yasm.tortall.net/Download.html](http://yasm.tortall.net/Download.html), rename to *yasm.exe* and put to ***BuildPath*\\ThirdParty\\yasm**
* Download **MSYS2** installer from [http://www.msys2.org/](http://www.msys2.org/) and install to ***BuildPath*\\ThirdParty\\msys64**
* Download **jom** archive from [http://download.qt.io/official_releases/jom/jom.zip](http://download.qt.io/official_releases/jom/jom.zip) and unpack to ***BuildPath*\\ThirdParty\\jom**
Build dependencies by script on Windows and macOS.
2021-08-25 09:46:32 +00:00
* Download **Python 3.9** installer from [https://www.python.org/downloads/](https://www.python.org/downloads/) and install to ***BuildPath*\\ThirdParty\\Python39**
Use VS 2022 with 10.0.22000.0 SDK version.
2021-11-26 14:13:58 +00:00
* Download **CMake 3.21 or later** installer from [https://cmake.org/download/](https://cmake.org/download/) and install to ***BuildPath*\\ThirdParty\\cmake**
Update build docs for VS 2017. Closes #3117. Closes #3729.
2017-09-06 09:12:27 +00:00
* Download **Ninja** executable from [https://github.com/ninja-build/ninja/releases/download/v1.7.2/ninja-win.zip](https://github.com/ninja-build/ninja/releases/download/v1.7.2/ninja-win.zip) and unpack to ***BuildPath*\\ThirdParty\\Ninja**
Update building-msvc.md Add some more requirements because without them users will get errors
2020-07-03 23:40:48 +00:00
* Download **Git** installer from [https://git-scm.com/download/win](https://git-scm.com/download/win) and install it.
Fixed NuGet link in instructions for Windows build.
2021-05-18 15:03:38 +00:00
* Download **NuGet** executable from [https://dist.nuget.org/win-x86-commandline/latest/nuget.exe](https://dist.nuget.org/win-x86-commandline/latest/nuget.exe) and put to ***BuildPath*\\ThirdParty\\NuGet**
Update building-msvc.md (#3264) * Update building-msvc.md Fixed some wrong, missing or unclear parts. Based on the problems I came into when trying to build and configure everything. Ninja not in path - from #3237 Newer msys - from #3247 Telegram.sln - from #2811 * Updated from the PR comments and added a signature Signed-off-by: Ariel Jannai <arieljannai@gmail.com> (github: arieljannai) * Updated by the latest comments from the PR Signed-off-by: Ariel Jannai <arieljannai@gmail.com> (github: arieljannai)
2017-04-14 09:58:10 +00:00
Build dependencies by script on Windows and macOS.
2021-08-25 09:46:32 +00:00
Add **Python 3.9** and **NuGet** to your PATH:
build instructions done for os x version
2014-06-25 20:15:34 +00:00
Add depot_tools information to build instructions.
2021-07-06 08:37:32 +00:00
* Open **Control Panel** -> **System** -> **Advanced system settings**.
* Press **Environment Variables...**.
* Select **Path**.
* Press **Edit**.
Build dependencies by script on Windows and macOS.
2021-08-25 09:46:32 +00:00
* Add ***BuildPath*\\ThirdParty\\Python39** value.
Add depot_tools information to build instructions.
2021-07-06 08:37:32 +00:00
* Add ***BuildPath*\\ThirdParty\\NuGet** value.
Removed some download-in-ZIP from build docs.
2016-10-11 09:56:51 +00:00
Use VS 2022 with 10.0.22000.0 SDK version.
2021-11-26 14:13:58 +00:00
Open **x86 Native Tools Command Prompt for VS 2022.bat**, go to ***BuildPath*** and run
build instructions done for os x version
2014-06-25 20:15:34 +00:00
Build dependencies by script on Windows and macOS.
2021-08-25 09:46:32 +00:00
python -m pip install pywin32
Fix breakpad installation on windows
2017-02-16 10:57:53 +00:00
Build dependencies by script on Windows and macOS.
2021-08-25 09:46:32 +00:00
## Clone source code and prepare libraries
Fix breakpad installation on windows
2017-02-16 10:57:53 +00:00
Use VS 2022 with 10.0.22000.0 SDK version.
2021-11-26 14:13:58 +00:00
Open **x86 Native Tools Command Prompt for VS 2022.bat**, go to ***BuildPath*** and run
build instructions done for os x version
2014-06-25 20:15:34 +00:00
Build dependencies by script on Windows and macOS.
2021-08-25 09:46:32 +00:00
git clone --recursive https://github.com/telegramdesktop/tdesktop.git
tdesktop\Telegram\build\prepare\win.bat
Add tgcalls library.
2020-07-09 17:38:26 +00:00
Update build docs for VS 2017. Closes #3117. Closes #3729.
2017-09-06 09:12:27 +00:00
## Build the project
Implement AppVeyor (#3025) Also implement build defines for Windows Set TELEGRAM_BUILD_DEFINES before calling gyp/refresh.bat Fix #3000 Signed-off-by: Christoph <auer.chrisi@gmx.net>
2017-02-18 19:23:50 +00:00
Minimal update of build instructions to use CMake.
2019-12-31 12:08:56 +00:00
Go to ***BuildPath*\\tdesktop\\Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
Implement AppVeyor (#3025) Also implement build defines for Windows Set TELEGRAM_BUILD_DEFINES before calling gyp/refresh.bat Fix #3000 Signed-off-by: Christoph <auer.chrisi@gmx.net>
2017-02-18 19:23:50 +00:00
Add -D DESKTOP_APP_DISABLE_CRASH_REPORTS=OFF to docs & actions
2020-08-10 14:10:42 +00:00
configure.bat -D TDESKTOP_API_ID=YOUR_API_ID -D TDESKTOP_API_HASH=YOUR_API_HASH -D DESKTOP_APP_USE_PACKAGED=OFF -D DESKTOP_APP_DISABLE_CRASH_REPORTS=OFF
Build docs updated, .sln files added to .gitignore.
2016-08-14 18:41:31 +00:00
Use VS 2022 with 10.0.22000.0 SDK version.
2021-11-26 14:13:58 +00:00
* Open ***BuildPath*\\tdesktop\\out\\Telegram.sln** in Visual Studio 2022
Update build docs for VS 2017. Closes #3117. Closes #3729.
2017-09-06 09:12:27 +00:00
* Select Telegram project and press Build > Build Telegram (Debug and Release configurations)
* The result Telegram.exe will be located in **D:\TBuild\tdesktop\out\Debug** (and **Release**)
Build docs updated, .sln files added to .gitignore.
2016-08-14 18:41:31 +00:00
Update build docs for VS 2017. Closes #3117. Closes #3729.
2017-09-06 09:12:27 +00:00
### Qt Visual Studio Tools
Build docs updated, .sln files added to .gitignore.
2016-08-14 18:41:31 +00:00
Update build docs for VS 2017. Closes #3117. Closes #3729.
2017-09-06 09:12:27 +00:00
For better debugging you may want to install Qt Visual Studio Tools:
Build docs updated, .sln files added to .gitignore.
2016-08-14 18:41:31 +00:00
doc
2020-06-10 04:08:51 +00:00
* Open **Extensions** -> **Manage Extensions**
Update build docs for VS 2017. Closes #3117. Closes #3729.
2017-09-06 09:12:27 +00:00
* Go to **Online** tab
* Search for **Qt**
* Install **Qt Visual Studio Tools** extension
Don't provide 'api_id' and 'api_hash' by default. We ask the developer to obtain his own api credentials, because the bundled 'api_id' / 'api_hash' are strictly limited by the server. The old credentials still could be used for test purposes, but the developer will need to explicitly opt-in to use them.
2018-11-04 10:29:30 +00:00
[api_credentials]: api_credentials.md