aboutsummaryrefslogtreecommitdiffhomepage
path: root/example
diff options
context:
space:
mode:
authorlevlam <levlam@telegram.org>2023-01-02 15:38:04 +0300
committerlevlam <levlam@telegram.org>2023-01-02 15:38:04 +0300
commit903d9947999f6298ff7f83987a4b6cc816f92e3a (patch)
treed4ac34af9009ece932ecf3eb487603b16cd64547 /example
parent8b763bedafb3919040af6ce95906c4f6d80f2655 (diff)
Improve punctuation.
Diffstat (limited to 'example')
-rw-r--r--example/README.md6
-rw-r--r--example/cpp/README.md4
-rw-r--r--example/csharp/README.md2
-rw-r--r--example/java/README.md4
-rw-r--r--example/python/README.md2
-rw-r--r--example/swift/README.md2
-rw-r--r--example/uwp/README.md3
7 files changed, 12 insertions, 11 deletions
diff --git a/example/README.md b/example/README.md
index c2c57642e..137f80e97 100644
--- a/example/README.md
+++ b/example/README.md
@@ -4,7 +4,7 @@ This directory contains basic examples of TDLib usage from different programming
If you are looking for documentation of all available TDLib methods, see the [td_api.tl](https://github.com/tdlib/td/blob/master/td/generate/scheme/td_api.tl) scheme or the
automatically generated [HTML documentation](https://core.telegram.org/tdlib/docs/td__api_8h.html) for a list of all available TDLib
[methods](https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1_function.html) and [classes](https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1_object.html).
-Also take a look at our [Getting Started](https://core.telegram.org/tdlib/getting-started) tutorial for a description of basic TDLib concepts.
+Also, take a look at our [Getting Started](https://core.telegram.org/tdlib/getting-started) tutorial for a description of basic TDLib concepts.
TDLib can be easily used from almost any programming language on any platform. See a [TDLib build instructions generator](https://tdlib.github.io/td/build.html) for detailed instructions on how to build TDLib.
Choose your preferred programming language to see examples of usage and a detailed description:
@@ -119,7 +119,7 @@ provides an asynchronous interface for interaction with TDLib, automatically gen
You can also use [TDLibCore](https://github.com/ph09nix/TDLibCore) library.
-Also see [Unigram](https://github.com/UnigramDev/Unigram), which is a full-featured client rewritten from scratch in C# using TDLib SDK for Universal Windows Platform in less than 2 months,
+Also, see [Unigram](https://github.com/UnigramDev/Unigram), which is a full-featured client rewritten from scratch in C# using TDLib SDK for Universal Windows Platform in less than 2 months,
[egram.tel](https://github.com/egramtel/egram.tel) – a cross-platform Telegram client written in C#, .NET Core, ReactiveUI and Avalonia, or
[telewear](https://github.com/telewear/telewear) - a Telegram client for Samsung watches.
@@ -189,7 +189,7 @@ See [rust-tdlib](https://github.com/aCLr/rust-tdlib), or [tdlib](https://github.
See [rtdlib](https://github.com/fewensa/rtdlib), [tdlib-rs](https://github.com/d653/tdlib-rs), [tdlib-futures](https://github.com/yuri91/tdlib-futures),
[tdlib-sys](https://github.com/nuxeh/tdlib-sys), [tdjson-rs](https://github.com/mersinvald/tdjson-rs), [rust-tdlib](https://github.com/vhaoran/rust-tdlib), or [tdlib-json-sys](https://github.com/aykxt/tdlib-json-sys) for examples of TDLib Rust bindings.
-Also see [Telegrand](https://github.com/melix99/telegrand) – a Telegram client optimized for the GNOME desktop.
+Also, see [Telegrand](https://github.com/melix99/telegrand) – a Telegram client optimized for the GNOME desktop.
<a name="erlang"></a>
## Using TDLib in Erlang projects
diff --git a/example/cpp/README.md b/example/cpp/README.md
index 1658ade6f..c8ee34d4f 100644
--- a/example/cpp/README.md
+++ b/example/cpp/README.md
@@ -8,9 +8,9 @@ cd build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=../example/cpp/td ..
cmake --build . --target install
```
-Also see [building](https://github.com/tdlib/td#building) for additional details on TDLib building.
+Also, see [building](https://github.com/tdlib/td#building) for additional details on TDLib building.
-Then you can build the examples:
+After this you can build the examples:
```
cd <path to TDLib sources>/example/cpp
mkdir build
diff --git a/example/csharp/README.md b/example/csharp/README.md
index b20d65947..c4b35afe1 100644
--- a/example/csharp/README.md
+++ b/example/csharp/README.md
@@ -35,4 +35,4 @@ After `TDLib` is built you can open and run TdExample project.
It contains a simple console C# application with implementation of authorization and message sending.
Just open it with Visual Studio 2015 or later and run.
-Also see TdExample.csproj for example of including TDLib in C# project with all native shared library dependencies.
+Also, see TdExample.csproj for example of including TDLib in C# project with all native shared library dependencies.
diff --git a/example/java/README.md b/example/java/README.md
index 4c7df1916..bca3e7ad9 100644
--- a/example/java/README.md
+++ b/example/java/README.md
@@ -19,7 +19,7 @@ If you want to compile TDLib for 32-bit/64-bit Java on Windows using MSVC, you w
In Windows, use vcpkg toolchain file by adding parameter -DCMAKE_TOOLCHAIN_FILE=<VCPKG_DIR>/scripts/buildsystems/vcpkg.cmake
-Then you can build this example:
+After this you can compile the example source code:
```
cd <path to TDLib sources>/example/java
mkdir build
@@ -30,7 +30,7 @@ cmake --build . --target install
Compiled TDLib shared library and Java example after that will be placed in bin/ and Javadoc documentation in `docs/`.
-Now you can run Java example:
+After this you can run the Java example:
```
cd <path to TDLib sources>/example/java/bin
java '-Djava.library.path=.' org/drinkless/tdlib/example/Example
diff --git a/example/python/README.md b/example/python/README.md
index c3c171d90..0afb4a70b 100644
--- a/example/python/README.md
+++ b/example/python/README.md
@@ -2,7 +2,7 @@
To run this example you need to [build](https://github.com/tdlib/td#building) TDLib and copy built tdjson shared library to this directory.
-Then you can run the example:
+After this you can run the example:
```
python tdjson_example.py
```
diff --git a/example/swift/README.md b/example/swift/README.md
index 7c57dcf64..ab7d85500 100644
--- a/example/swift/README.md
+++ b/example/swift/README.md
@@ -9,7 +9,7 @@ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=../example/swift/td
cmake --build . --target install
```
-Then you can open and build the example with the latest Xcode.
+After this you can open and build the example with the latest Xcode.
Description of all available classes and methods can be found at [td_json_client](https://core.telegram.org/tdlib/docs/td__json__client_8h.html)
and [td_api](https://core.telegram.org/tdlib/docs/td__api_8h.html) documentation.
diff --git a/example/uwp/README.md b/example/uwp/README.md
index c0b4de723..3a78deedf 100644
--- a/example/uwp/README.md
+++ b/example/uwp/README.md
@@ -22,7 +22,8 @@ powershell -ExecutionPolicy ByPass .\build.ps1 -vcpkg_root C:\vcpkg
If you need to restart the build from scratch, call `.\build.ps1 -vcpkg_root C:\vcpkg -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.
-Now `TDLib` can be used from any UWP project, built in Visual Studio.
+After this `TDLib` can be used from any UWP project, built in Visual Studio.
## Example of usage
+
The `app/` directory contains a simple example of a C# application for Universal Windows Platform. Just open it with Visual Studio 2015 or later and run.