diff --git a/README.md b/README.md index 917a31e..3e33326 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Тальк — клиент Telegram с текстовым пользовательским интерфейсом, написанный на Python, Telethon и Textual. +Будьте добры, по-русски | [In English, please](readme/README-en.md) + ## Требования - Python 3.12 diff --git a/readme/README-en.md b/readme/README-en.md new file mode 100644 index 0000000..30e406c --- /dev/null +++ b/readme/README-en.md @@ -0,0 +1,44 @@ +# Talc + +Talc is a Telegram client with TUI, written in Python, Telethon and Textual. + +[Будьте добры, по-русски](../README.md) | In English, please + +## Requirements + +- Python 3.12 +- pyenv (recommended for managing Python versions) + +## Установка + +1. Install Python 3.12 via pyenv: +```bash +pyenv install 3.12 +pyenv local 3.12 +``` + +2. Create and activate virtual enviroment: +```bash +python -m venv .venv +source .venv/bin/activate # for Linux/macOS +# or +.venv\Scripts\activate # for Windows +``` + +3. Install dependencies: +```bash +pip install -r requirements.txt +``` + +4. Configure enviroment variables: +```bash +cp .env.example .env +# Configure .env file and add your API-keys +# Get keys on https://my.telegram.org/apps +``` + +## Run + +```bash +./main.py +```