A simple TUI for Telegram
[![Crates.io][crates-io-shield]][crates-io] [![GitHub CI Linux][github-ci-linux-shield]][github-ci-linux] [![GitHub CI Windows][github-ci-windows-shield]][github-ci-windows] [![GitHub CI macOS][github-ci-macos-shield]][github-ci-macos]  [![Crates.io Downloads][creates-io-downloads-shield]][creates-io-downloads] [![][total-lines-shield]][total-lines] ## About `tgt` is a terminal user interface for Telegram, written in Rust. ## Contributing Contributions to this project are welcome! If you have any suggestions, improvements, or bug fixes, feel free to submit a pull request. For more information, do not hesitate to contact us (see the [Contact](#contact) section). **Build instructions** There are three ways to build `tgt`: 1. Using the `download-tdlib` feature of [tdlib-rs](https://github.com/FedericoBruzzone/tdlib-rs) you do not need to set any environment variable. Then you can compile `tgt` using `cargo build --features download-tdlib`. 2. By default, `tgt` assumes that you have the tdlib built and the `LOCAL_TDLIB_PATH` environment variable set to the path of the `tdlib` directory. You can set the environment variable with the following command: `export LOCAL_TDLIB_PATH="/path/to/tdlib"`. Then you can compile `tgt` using `cargo build` or `cargo build --feature default`. 3. You can use `pkg-config` to find the path of the library. In this case see the [CONTRIBUTING.md](https://github.com/FedericoBruzzone/tgt/blob/main/CONTRIBUTING.md) file for more information. Then you can compile `tgt` using `cargo build --features pkg-config`. The [CONTRIBUTING.md](https://github.com/FedericoBruzzone/tgt/blob/main/CONTRIBUTING.md) file contains information for building `tgt` and the steps to configure the `tdlib` in your local environment, starting from the compilation to the configuration of the environment variables. ### Road Map You can find the road map of the project [here](https://github.com/FedericoBruzzone/tg-tui/issues/1) (in the pinned issues). ## Commands You can use `just`, `make` or `cargo`, as build tools. If you want to use `cargo`, please make sure to read the `Justfile` or the `Makefile` to understand the flags used for each command. Here are the available commands: ```text just COMMAND make COMMAND COMMAND: all # Run fmt, clippy and test build # Build the project run # Run the project test # Run the tests clippy # Run clippy fmt # Run rustfmt clean # Clean the project ``` ## License This repository are licensed under either of * Apache License, Version 2.0 ([LICENSE-APACHE][github-license-apache] or http://www.apache.org/licenses/LICENSE-2.0) * MIT license ([LICENSE-MIT][github-license-mit] or http://opensource.org/licenses/MIT) at your option. Please review the license file provided in the repository for more information regarding the terms and conditions of the license. ## Contact - Email: - [federico.bruzzone.i@gmail.com] - [federico.bruzzone@studenti.unimi.it] - [andrea.longoni3@studenti.unimi.it] - GitHub: - [FedericoBruzzone](https://github.com/FedericoBruzzone) - [Andreal2000](https://github.com/Andreal2000)