Slavasil/mmcs-quotes-bridge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add README

Browse Source
This commit is contained in:
Slavasil 2025-01-05 05:06:25 +03:00
parent 9d95c98424
commit a8be017843
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# MMCS Quotes Bridge
> Текущее название является рабочим вариантом, имеет мало общего с сутью проекта, все совпадения аббревиатур с реальными случайны и не несут никакой смысловой нагрузки.
>
> *P.S. кто знает тот знает короче :DDD*
Этот проект - реализация бота, предназначенного для репоста текстовых постов из источников в VK и Telegram в один выходной Telegram-канал. Изначальная цель - репостить цитаты из разных цитатников в один канал, но в принципе вы можете придумать своё применение.
## Платформа
**Операционная система.** Предполагается работа на Linux, но теоретически можно заставить бота работать и на других системах.
**Компилятор.** Проект написан на C++20 и соответственно требует более-менее современный компилятор.
## Зависимости
Большая часть необходимых библиотек присутствует в репозитории, однако для того, чтобы скачать их вместе с проектом, при клонировании требуется указать --recursive.
CMakeLists настроен на максимально портативный билд, однако всё же не все библиотеки встраиваются в исполняемый файл.
Для работы бота достаточно установленной библиотеки curl.
Для сборки (помимо CMake) нужны следующие дополнительные пакеты:
- gperf
- заголовочные файлы для OpenSSL, zlib
По вопросам сборки можно писать в issues.
## Конфигурация
Для настройки используется файл `bridge_config.json`. В качестве примера настройки оставлен `bridge_config.example.json`, который нужно отредактировать под себя.