From a8be0178436e94f7de1790ae0daf4e4fa56a27d7 Mon Sep 17 00:00:00 2001 From: Slavasil Date: Sun, 5 Jan 2025 05:06:25 +0300 Subject: [PATCH] add README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..885b300 --- /dev/null +++ b/README.md @@ -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`, который нужно отредактировать под себя. \ No newline at end of file