From 0a735b8c7bea01caa594258bc5acff4cc128718b Mon Sep 17 00:00:00 2001 From: levlam Date: Sun, 8 Jul 2018 03:18:46 +0300 Subject: [PATCH] Improve Readme. GitOrigin-RevId: 55d9ac20bde93220befaea33e17519bd0160e9c0 --- README.md | 7 +++++-- example/csharp/README.md | 7 ++++--- example/uwp/README.md | 7 ++++--- tdutils/generate/CMakeLists.txt | 2 +- 4 files changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6fae3149..71d890a4 100644 --- a/README.md +++ b/README.md @@ -78,15 +78,18 @@ cmake -DCMAKE_BUILD_TYPE=Release -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl/ .. #### Windows +* Download and install Microsoft Visual Studio 2015 or later. * Download and install [gperf](https://sourceforge.net/projects/gnuwin32/files/gperf/3.0.1/). Add the path to gperf.exe to the PATH environment variable. * Install [vcpkg](https://github.com/Microsoft/vcpkg#quick-start). * Run the following commands to install `TDLib` dependencies using vcpkg: ``` -C:\src\vcpkg> .\vcpkg.exe install openssl:x64-windows openssl:x86-windows zlib:x64-windows zlib:x86-windows +cd +.\vcpkg.exe install openssl:x64-windows openssl:x86-windows zlib:x64-windows zlib:x86-windows ``` +* Download and install [cmake](https://cmake.org/download/); choose "Add CMake to the system PATH" option while installing. * Build `TDLib` with CMake as explained in [building](#building), but instead of `cmake -DCMAKE_BUILD_TYPE=Release ..` use ``` -cmake -DCMAKE_TOOLCHAIN_FILE=C:\src\vcpkg\scripts\buildsystems\vcpkg.cmake .. +cmake -DCMAKE_TOOLCHAIN_FILE=\scripts\buildsystems\vcpkg.cmake .. ``` To build 64-bit `TDLib` using MSVC, you will need to additionally specify parameter `-A x64` to CMake. diff --git a/example/csharp/README.md b/example/csharp/README.md index 2faa15e1..b243861e 100644 --- a/example/csharp/README.md +++ b/example/csharp/README.md @@ -5,11 +5,12 @@ This is an example of building TDLib with `C++/CLI` support and an example of TD ## Building TDLib * Download and install Microsoft Visual Studio 2015 or later. -* Download and install [CMake](https://cmake.org/download/). +* Download and install [CMake](https://cmake.org/download/); choose "Add CMake to the system PATH" option while installing. * Install [vcpkg](https://github.com/Microsoft/vcpkg#quick-start) or update it to the latest version using `vcpkg update` and following received instructions. * Install `zlib` and `openssl` for using `vcpkg`: ``` -C:\src\vcpkg> .\vcpkg.exe install openssl:x64-windows openssl:x86-windows zlib:x64-windows zlib:x86-windows +cd +.\vcpkg.exe install openssl:x64-windows openssl:x86-windows zlib:x64-windows zlib:x86-windows ``` * (Optional. For XML documentation generation.) Download [PHP](https://windows.php.net/download#php-7.2). Add the path to php.exe to the PATH environment variable. * Download and install [gperf](https://sourceforge.net/projects/gnuwin32/files/gperf/3.0.1/). Add the path to gperf.exe to the PATH environment variable. @@ -18,7 +19,7 @@ C:\src\vcpkg> .\vcpkg.exe install openssl:x64-windows openssl:x86-windows zlib:x cd /example/csharp mkdir build cd build -cmake -DTD_ENABLE_DOTNET=ON -DCMAKE_TOOLCHAIN_FILE=C:\src\vcpkg\scripts\buildsystems\vcpkg.cmake ../../.. +cmake -DTD_ENABLE_DOTNET=ON -DCMAKE_TOOLCHAIN_FILE=\scripts\buildsystems\vcpkg.cmake ../../.. cmake --build . --config Release cmake --build . --config Debug ``` diff --git a/example/uwp/README.md b/example/uwp/README.md index e7bb9b82..866cc2d3 100644 --- a/example/uwp/README.md +++ b/example/uwp/README.md @@ -9,15 +9,16 @@ This is an example of building TDLib SDK for Universal Windows Platform and an e * Install [vcpkg](https://github.com/Microsoft/vcpkg#quick-start) or update it to the latest version using `vcpkg update` and following received instructions. * Install `zlib` and `openssl` for all UWP architectures using `vcpkg`: ``` -C:\src\vcpkg> .\vcpkg.exe install openssl:arm-uwp openssl:x64-uwp openssl:x86-uwp zlib:arm-uwp zlib:x64-uwp zlib:x86-uwp +cd +.\vcpkg.exe install openssl:arm-uwp openssl:x64-uwp openssl:x86-uwp zlib:arm-uwp zlib:x64-uwp zlib:x86-uwp ``` * (Optional. For XML documentation generation.) Download [PHP](https://windows.php.net/download#php-7.2). Add the path to php.exe to the PATH environment variable. * Download and install [gperf](https://sourceforge.net/projects/gnuwin32/files/gperf/3.0.1/). Add the path to gperf.exe to the PATH environment variable. * Download and install [7-Zip](http://www.7-zip.org/download.html) archiver, which is used by the `build.ps1` script to create a Telegram.Td.UWP Visual Studio Extension. Add the path to 7z.exe to the PATH environment variable. Alternatively `build.ps1` supports compressing using [WinRAR](https://en.wikipedia.org/wiki/WinRAR) with option `-compress winrar` and compressing using [zip](http://gnuwin32.sourceforge.net/packages/zip.htm) with `-compress zip`. -* Build `TDLib` using provided `build.ps1` script (TDLib should be built 6 times for multiple platforms in Debug and Release configurations, so it make take few hours). Pass path to vcpkg.exe as `-vcpkg-root` argument: +* Build `TDLib` using provided `build.ps1` script (TDLib should be built 6 times for multiple platforms in Debug and Release configurations, so it make take few hours). Pass path to vcpkg.exe as `-vcpkg-root` argument, for example: ``` -powershell -ExecutionPolicy ByPass .\build.ps1 -vcpkg_root C:\src\vcpkg +powershell -ExecutionPolicy ByPass .\build.ps1 -vcpkg_root C:\vcpkg ``` If you need to restart the build from scratch, call `.\build.ps1 -mode clean` first. * Install Visual Studio Extension "TDLib for Universal Windows Platform" located at `build-uwp\vsix\tdlib.vsix`, which was created on the previous step by `build.ps1` script. diff --git a/tdutils/generate/CMakeLists.txt b/tdutils/generate/CMakeLists.txt index 69697b04..9eca574a 100644 --- a/tdutils/generate/CMakeLists.txt +++ b/tdutils/generate/CMakeLists.txt @@ -19,7 +19,7 @@ add_custom_target(tdmime_auto DEPENDS ${TDMIME_SOURCE}) if (NOT CMAKE_CROSSCOMPILING) find_program(GPERF_EXECUTABLE gperf) if (NOT GPERF_EXECUTABLE) - message(FATAL_ERROR "Could NOT find gperf. Path to gperf needs to be specified manually, i.e. 'cmake -DGPERF_EXECUTABLE:FILEPATH=\"\" .')") + message(FATAL_ERROR "Could NOT find gperf. Add path to gperf executable to PATH environment variable or specify it manually using GPERF_EXECUTABLE option, i. e. 'cmake -DGPERF_EXECUTABLE:FILEPATH=\"\"'.") endif() set(GPERF_FILES