Рефакторинг файлов README.md и документации

src/altlinux/README.md

@@ -2,45 +2,54 @@
 
 ## Описание
 
-Подготовленная версия Karkas Lite для интеграции в чат [Альт Линукс](https://t.me/alt_linux)
+Бот, созданный на основе платформы «Каркас» и подготовленный для интеграции в чат [Альт Линукс](https://t.me/alt_linux)
 
 ## Функционал
-Список OCAB-модулей используемых в боте:
 
-* report - Вызов администрации чата одной командой
-* welcome - Автоматическая вариативная проверка пользователей на признаки бота или другой автоматической рекламной системы
-* help - Получение информации об Karkas Lite
+Список блоков, используемых в боте:
+
+- `report` — вызов администрации чата одной командой;
+- `welcome` — автоматическая вариативная проверка пользователей на признаки бота или другой рекламной системы;
+- `help` — получение справки о боте.
 
 ## Запуск
 
-### Docker
+### Через Docker образ
+
+1. Соберите Docker образ:
+
+```shell
+docker build -t altlinux -f Dockerfile ../..
+```
 
-1. Соберите Docker-образ:
-    ```bash
-    docker build -t gnomik .
-    ```
 2. Запустите контейнер:
-    ```bash
-    docker run -p 9000:9000 -v ./config.yaml:/app/config.yaml -v ./database:/app/database gnomik
-    ```
 
-    Замените `./config.yaml` и `./database` на пути к вашим локальным файлам конфигурации и паки для базы данных.
+```shell
+docker run -v ./config.yaml:/app/config.yaml altlinux
+```
+
+Замените `./config.yaml` на путь к локальному файлу конфигурации.
 
 ### Вручную
 
-1. Активируйте виртуальное окружение Gnomика:
-    ```bash
-    poetry shell
-    ```
+1. Активируйте виртуальное окружение:
+
+```shell
+poetry shell
+```
+
 2. Запустите бота:
-    ```bash
-    python -m gnomik
-    ```
+
+```shell
+python -m altlinux
+```
 
 ## Конфигурация
 
-Конфигурация бота находится в файле `config.yaml`.
+Конфигурация хранится в файле `config.yaml`.
 
-## Модули
+Пример конфигурации бота находится в файле [`config-example.yaml`](./config-example.yaml).
 
-Список загружаемых модулей указан в файле `__main__.py`.
+## Блоки
+
+Список загружаемых блоков указан в файле [`__main__.py`](./altlinux/__main__.py).