kotatogram/kotatogram-desktop
kotatogram/kotatogram-desktop
1
0
Fork 0
Code Issues Releases 45 Packages Wiki Activity

Updated README and some docs

Browse source
This commit is contained in:
Eric Kotato 2021-01-04 08:48:01 +03:00
parent 889b774712
commit d27455b201
4 changed files with 89 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -8,13 +8,16 @@
[![Preview of Kotatogram Desktop][preview_image]][preview_image_url] [![Preview of Kotatogram Desktop][preview_image]][preview_image_url]
Original README with build instructions and licenses could be found in [Telegram Desktop repository][telegram_desktop_readme]. Build instructions can be found [in `docs` folder][build]. Please note: only [32-bit Windows][building-msvc], [64-bit Windows][building-msvc-x64] and [Linux][building-cmake] build instructions are updated.
Original README with licenses could be found in [Telegram Desktop repository][telegram_desktop_readme].
## Builds ## Builds
* Windows (installer and portable) * Windows (installer and portable)
* Linux (64-bit) * Linux (64-bit)
* [Flathub][flatpak] * [Flathub][flatpak]
* Other repositories:<br>[![Packaging status](https://repology.org/badge/vertical-allrepos/kotatogram-desktop.svg)][repology] * Other repositories:<br>[![Packaging status](https://repology.org/badge/vertical-allrepos/kotatogram-desktop.svg)][repology]
* macOS (packaged)
## Features ## Features
* Local folders * Local folders
@ -53,3 +56,7 @@ Read [CONTRIBUTING.md][contributing].
[preview_image_url]: https://github.com/kotatogram/kotatogram-desktop/blob/dev/docs/assets/ktg_preview.png [preview_image_url]: https://github.com/kotatogram/kotatogram-desktop/blob/dev/docs/assets/ktg_preview.png
[contributing]: https://github.com/kotatogram/kotatogram-desktop/blob/dev/.github/CONTRIBUTING.md [contributing]: https://github.com/kotatogram/kotatogram-desktop/blob/dev/.github/CONTRIBUTING.md
[archive]: https://github.com/kotatogram/kotatogram-archived [archive]: https://github.com/kotatogram/kotatogram-archived
[build]: https://github.com/kotatogram/kotatogram-desktop/blob/dev/docs
[building-msvc]: https://github.com/kotatogram/kotatogram-desktop/blob/dev/docs/building-msvc.md
[building-msvc-x64]: https://github.com/kotatogram/kotatogram-desktop/blob/dev/docs/building-msvc-x64.md
[building-cmake]: https://github.com/kotatogram/kotatogram-desktop/blob/dev/docs/building-cmake.md

18
docs/building-cmake.md
View file

@ -6,38 +6,40 @@ You will require **api_id** and **api_hash** to access the Telegram API servers.
### Clone source code ### Clone source code
git clone --recursive https://github.com/telegramdesktop/tdesktop.git git clone --recursive https://github.com/kotatogram/kotatogram-desktop.git
### Prepare libraries ### Prepare libraries
Go to the `tdesktop` directory and run Go to the `kotatogram-desktop` directory and run
docker build -t tdesktop:centos_env Telegram/build/docker/centos_env/ docker build -t kotatogram-desktop:centos_env Telegram/build/docker/centos_env/
### Building the project ### Building the project
Make sure that you're still in the `tdesktop` directory and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials)) Make sure that you're still in the `kotatogram-desktop` directory and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
docker run --rm \ docker run --rm \
-v $PWD:/usr/src/tdesktop \ -v $PWD:/usr/src/tdesktop \
tdesktop:centos_env \ kotatogram-desktop:centos_env \
/usr/src/tdesktop/Telegram/build/docker/centos_env/build.sh \ /usr/src/tdesktop/Telegram/build/docker/centos_env/build.sh \
-D TDESKTOP_API_ID=YOUR_API_ID \ -D TDESKTOP_API_ID=YOUR_API_ID \
-D TDESKTOP_API_HASH=YOUR_API_HASH \ -D TDESKTOP_API_HASH=YOUR_API_HASH \
-D DESKTOP_APP_USE_PACKAGED=OFF \ -D DESKTOP_APP_USE_PACKAGED=OFF \
-D DESKTOP_APP_DISABLE_CRASH_REPORTS=OFF -D DESKTOP_APP_DISABLE_CRASH_REPORTS=ON
Or, to create a debug build, run (also using [your **api_id** and **api_hash**](#obtain-your-api-credentials)) Or, to create a debug build, run (also using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
docker run --rm \ docker run --rm \
-v $PWD:/usr/src/tdesktop \ -v $PWD:/usr/src/tdesktop \
-e DEBUG=1 \ -e DEBUG=1 \
tdesktop:centos_env \ kotatogram-desktop:centos_env \
/usr/src/tdesktop/Telegram/build/docker/centos_env/build.sh \ /usr/src/tdesktop/Telegram/build/docker/centos_env/build.sh \
-D TDESKTOP_API_ID=YOUR_API_ID \ -D TDESKTOP_API_ID=YOUR_API_ID \
-D TDESKTOP_API_HASH=YOUR_API_HASH \ -D TDESKTOP_API_HASH=YOUR_API_HASH \
-D DESKTOP_APP_USE_PACKAGED=OFF \ -D DESKTOP_APP_USE_PACKAGED=OFF \
-D DESKTOP_APP_DISABLE_CRASH_REPORTS=OFF -D DESKTOP_APP_DISABLE_CRASH_REPORTS=ON
If you want to build with crash reporter, use `-D DESKTOP_APP_DISABLE_CRASH_REPORTS=OFF` instead of `-D DESKTOP_APP_DISABLE_CRASH_REPORTS=ON`.
The built files will be in the `out` directory. The built files will be in the `out` directory.

81
docs/building-msvc-x64.md
View file

@ -33,7 +33,7 @@ Open **x64 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
cd ThirdParty cd ThirdParty
git clone https://github.com/desktop-app/patches.git git clone https://github.com/desktop-app/patches.git
cd patches cd patches
git checkout 9fb66f2 git checkout 41ead72
cd ../ cd ../
git clone https://chromium.googlesource.com/external/gyp git clone https://chromium.googlesource.com/external/gyp
cd gyp cd gyp
@ -56,14 +56,14 @@ Open **x64 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
SET PATH=%cd%\ThirdParty\Strawberry\perl\bin;%cd%\ThirdParty\Python27;%cd%\ThirdParty\NASM;%cd%\ThirdParty\jom;%cd%\ThirdParty\cmake\bin;%cd%\ThirdParty\yasm;%PATH% SET PATH=%cd%\ThirdParty\Strawberry\perl\bin;%cd%\ThirdParty\Python27;%cd%\ThirdParty\NASM;%cd%\ThirdParty\jom;%cd%\ThirdParty\cmake\bin;%cd%\ThirdParty\yasm;%PATH%
git clone --recursive https://github.com/telegramdesktop/tdesktop.git git clone --recursive https://github.com/kotatogram/kotatogram-desktop.git
if not exist Libraries\win64 mkdir Libraries\win64 mkdir Libraries64
cd Libraries\win64 cd Libraries64
git clone https://github.com/desktop-app/patches.git git clone https://github.com/desktop-app/patches.git
cd patches cd patches
git checkout 9fb66f2 git checkout 41ead72
cd .. cd ..
git clone https://github.com/desktop-app/lzma.git git clone https://github.com/desktop-app/lzma.git
@ -108,9 +108,9 @@ Open **x64 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
cmake --build . --config Release cmake --build . --config Release
cd .. cd ..
git clone https://github.com/telegramdesktop/openal-soft.git git clone https://github.com/kcat/openal-soft.git
cd openal-soft cd openal-soft
git checkout fix_mono git checkout openal-soft-1.21.0
cd build cd build
cmake .. ^ cmake .. ^
-G "Visual Studio 16 2019" ^ -G "Visual Studio 16 2019" ^
@ -121,22 +121,6 @@ Open **x64 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
msbuild OpenAL.vcxproj /property:Configuration=RelWithDebInfo /property:Platform="x64" msbuild OpenAL.vcxproj /property:Configuration=RelWithDebInfo /property:Platform="x64"
cd ..\.. cd ..\..
git clone https://github.com/google/breakpad
cd breakpad
git checkout a1dbcdcb43
git apply ../patches/breakpad.diff
cd src
git clone https://github.com/google/googletest testing
cd client\windows
gyp --no-circular-check breakpad_client.gyp --format=ninja
cd ..\..
ninja -C out/Debug_x64 common crash_generation_client exception_handler
ninja -C out/Release_x64 common crash_generation_client exception_handler
cd tools\windows\dump_syms
gyp dump_syms.gyp
msbuild dump_syms.vcxproj /property:Configuration=Release /property:Platform="x64"
cd ..\..\..\..\..
git clone https://github.com/telegramdesktop/opus.git git clone https://github.com/telegramdesktop/opus.git
cd opus cd opus
git checkout tdesktop git checkout tdesktop
@ -144,10 +128,10 @@ Open **x64 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
msbuild opus.sln /property:Configuration=Debug /property:Platform="x64" msbuild opus.sln /property:Configuration=Debug /property:Platform="x64"
msbuild opus.sln /property:Configuration=Release /property:Platform="x64" msbuild opus.sln /property:Configuration=Release /property:Platform="x64"
cd ..\..\..\..\.. cd ..\..\..\..
SET PATH_BACKUP_=%PATH% SET PATH_BACKUP_=%PATH%
SET PATH=%cd%\ThirdParty\msys64\usr\bin;%PATH% SET PATH=%cd%\ThirdParty\msys64\usr\bin;%PATH%
cd Libraries\win64 cd Libraries64
git clone https://github.com/FFmpeg/FFmpeg.git ffmpeg git clone https://github.com/FFmpeg/FFmpeg.git ffmpeg
cd ffmpeg cd ffmpeg
@ -161,17 +145,17 @@ Open **x64 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
cd .. cd ..
SET LibrariesPath=%cd% SET LibrariesPath=%cd%
git clone git://code.qt.io/qt/qt5.git qt_5_15_1 git clone git://code.qt.io/qt/qt5.git qt_5_15_2
cd qt_5_15_1 cd qt_5_15_2
perl init-repository --module-subset=qtbase,qtimageformats perl init-repository --module-subset=qtbase,qtimageformats
git checkout v5.15.1 git checkout v5.15.2
git submodule update qtbase qtimageformats git submodule update qtbase qtimageformats
cd qtbase cd qtbase
for /r %i in (..\..\patches\qtbase_5_15_1\*) do git apply %i for /r %i in (..\..\patches\qtbase_5_15_2\*) do git apply %i
cd .. cd ..
configure ^ configure ^
-prefix "%LibrariesPath%\Qt-5.15.1" ^ -prefix "%LibrariesPath%\Qt-5.15.2" ^
-debug-and-release ^ -debug-and-release ^
-force-debug-info ^ -force-debug-info ^
-opensource ^ -opensource ^
@ -207,7 +191,9 @@ Open **x64 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
-DTG_OWT_LIBJPEG_INCLUDE_PATH=%cd%/../../../mozjpeg ^ -DTG_OWT_LIBJPEG_INCLUDE_PATH=%cd%/../../../mozjpeg ^
-DTG_OWT_OPENSSL_INCLUDE_PATH=%cd%/../../../openssl_1_1_1/include ^ -DTG_OWT_OPENSSL_INCLUDE_PATH=%cd%/../../../openssl_1_1_1/include ^
-DTG_OWT_OPUS_INCLUDE_PATH=%cd%/../../../opus/include ^ -DTG_OWT_OPUS_INCLUDE_PATH=%cd%/../../../opus/include ^
-DTG_OWT_FFMPEG_INCLUDE_PATH=%cd%/../../../ffmpeg ../.. -DTG_OWT_FFMPEG_INCLUDE_PATH=%cd%/../../../ffmpeg ^
-DCMAKE_C_COMPILER=cl ^
-DCMAKE_CXX_COMPILER=cl ../..
ninja ninja
cd .. cd ..
mkdir Release mkdir Release
@ -218,19 +204,42 @@ Open **x64 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
-DTG_OWT_LIBJPEG_INCLUDE_PATH=%cd%/../../../mozjpeg ^ -DTG_OWT_LIBJPEG_INCLUDE_PATH=%cd%/../../../mozjpeg ^
-DTG_OWT_OPENSSL_INCLUDE_PATH=%cd%/../../../openssl_1_1_1/include ^ -DTG_OWT_OPENSSL_INCLUDE_PATH=%cd%/../../../openssl_1_1_1/include ^
-DTG_OWT_OPUS_INCLUDE_PATH=%cd%/../../../opus/include ^ -DTG_OWT_OPUS_INCLUDE_PATH=%cd%/../../../opus/include ^
-DTG_OWT_FFMPEG_INCLUDE_PATH=%cd%/../../../ffmpeg ../.. -DTG_OWT_FFMPEG_INCLUDE_PATH=%cd%/../../../ffmpeg ^
-DCMAKE_C_COMPILER=cl ^
-DCMAKE_CXX_COMPILER=cl ../..
ninja ninja
cd ..\..\.. cd ..\..\..
You can also build Breakpad in case you want to build with crash reporter:
git clone https://github.com/google/breakpad
cd breakpad
git checkout a1dbcdcb43
git apply ../patches/breakpad.diff
cd src
git clone https://github.com/google/googletest testing
cd client\windows
gyp --no-circular-check breakpad_client.gyp --format=ninja
cd ..\..
ninja -C out/Debug_x64 common crash_generation_client exception_handler
ninja -C out/Release_x64 common crash_generation_client exception_handler
cd tools\windows\dump_syms
gyp dump_syms.gyp
msbuild dump_syms.vcxproj /property:Configuration=Release /property:Platform="x64"
cd ..\..\..\..\..
## Build the project ## Build the project
Go to ***BuildPath*\\tdesktop\\Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials)) Go to ***BuildPath*\\kotatogram-desktop\\Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
configure.bat x64 -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 configure.bat x64 -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=ON
* Open ***BuildPath*\\tdesktop\\out\\Telegram.sln** in Visual Studio 2019 If you want to build with crash reporter, use `-D DESKTOP_APP_DISABLE_CRASH_REPORTS=OFF` instead of `-D DESKTOP_APP_DISABLE_CRASH_REPORTS=ON`.
* Open ***BuildPath*\\kotatogram-desktop\\out64\\Telegram.sln** in Visual Studio 2019
* Select Telegram project and press Build > Build Telegram (Debug and Release configurations) * 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**) * The result Kotatogram.exe will be located in **D:\TBuild\kotatogram-desktop\out64\Debug** (and **Release**)
### Qt Visual Studio Tools ### Qt Visual Studio Tools

47
docs/building-msvc.md
View file

@ -56,7 +56,7 @@ Open **x86 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
SET PATH=%cd%\ThirdParty\Strawberry\perl\bin;%cd%\ThirdParty\Python27;%cd%\ThirdParty\NASM;%cd%\ThirdParty\jom;%cd%\ThirdParty\cmake\bin;%cd%\ThirdParty\yasm;%PATH% SET PATH=%cd%\ThirdParty\Strawberry\perl\bin;%cd%\ThirdParty\Python27;%cd%\ThirdParty\NASM;%cd%\ThirdParty\jom;%cd%\ThirdParty\cmake\bin;%cd%\ThirdParty\yasm;%PATH%
git clone --recursive https://github.com/telegramdesktop/tdesktop.git git clone --recursive https://github.com/kotatogram/kotatogram-desktop.git
mkdir Libraries mkdir Libraries
cd Libraries cd Libraries
@ -121,22 +121,6 @@ Open **x86 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
msbuild OpenAL.vcxproj /property:Configuration=RelWithDebInfo msbuild OpenAL.vcxproj /property:Configuration=RelWithDebInfo
cd ..\.. cd ..\..
git clone https://github.com/google/breakpad
cd breakpad
git checkout a1dbcdcb43
git apply ../patches/breakpad.diff
cd src
git clone https://github.com/google/googletest testing
cd client\windows
gyp --no-circular-check breakpad_client.gyp --format=ninja
cd ..\..
ninja -C out/Debug common crash_generation_client exception_handler
ninja -C out/Release common crash_generation_client exception_handler
cd tools\windows\dump_syms
gyp dump_syms.gyp
msbuild dump_syms.vcxproj /property:Configuration=Release
cd ..\..\..\..\..
git clone https://github.com/telegramdesktop/opus.git git clone https://github.com/telegramdesktop/opus.git
cd opus cd opus
git checkout tdesktop git checkout tdesktop
@ -222,15 +206,36 @@ Open **x86 Native Tools Command Prompt for VS 2019.bat**, go to ***BuildPath***
ninja ninja
cd ..\..\.. cd ..\..\..
You can also build Breakpad in case you want to build with crash reporter:
git clone https://github.com/google/breakpad
cd breakpad
git checkout a1dbcdcb43
git apply ../patches/breakpad.diff
cd src
git clone https://github.com/google/googletest testing
cd client\windows
gyp --no-circular-check breakpad_client.gyp --format=ninja
cd ..\..
ninja -C out/Debug common crash_generation_client exception_handler
ninja -C out/Release common crash_generation_client exception_handler
cd tools\windows\dump_syms
gyp dump_syms.gyp
msbuild dump_syms.vcxproj /property:Configuration=Release
cd ..\..\..\..\..
## Build the project ## Build the project
Go to ***BuildPath*\\tdesktop\\Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials)) Go to ***BuildPath*\\kotatogram-desktop\\Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
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 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=ON
* Open ***BuildPath*\\tdesktop\\out\\Telegram.sln** in Visual Studio 2019 If you want to build with crash reporter, use `-D DESKTOP_APP_DISABLE_CRASH_REPORTS=OFF` instead of `-D DESKTOP_APP_DISABLE_CRASH_REPORTS=ON`.
* Open ***BuildPath*\\kotatogram-desktop\\out\\Telegram.sln** in Visual Studio 2019
* Select Telegram project and press Build > Build Telegram (Debug and Release configurations) * 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**) * The result Kotatogram.exe will be located in **D:\TBuild\kotatogram-desktop\out\Debug** (and **Release**)
### Qt Visual Studio Tools ### Qt Visual Studio Tools