mirrors/karkas
0
0
Fork 0
mirror of https://gitflic.ru/project/alt-gnome/karkas.git synced 2025-11-01 22:11:23 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
x1z53
2024-08-25 14:52:07 +03:00
parent 04a4ab4868
commit 5f5e851ecd
21 changed files with 349 additions and 346 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
src/gnomik/README.md
View File

@@ -2,17 +2,16 @@
![Логотип](./docs/gnomik.jpg)
Чат-бот помощник в [ALT Gnome Chat](https://t.me/alt_gnome_chat).
Gnomик — это чат-бот для [ALT Gnome Chat](https://t.me/alt_gnome_chat), созданный на основе платформы «Каркас». Он предоставляет различные функции и возможности, помогающие членам сообщества ALT Gnome.
ALT Regular Gnome Community - открытое сообщество пользователей операционной системы ALT Regular Gnome.
- [Канал](https://t.me/alt_gnome)
- [Wiki](https://alt-gnome.wiki)
## Описание
Gnomик - это чат-бот для Telegram, разработанный на платформе Karkas. Он предоставляет различные функции и возможности, помогающие пользователям операционной системы ALT Regular Gnome.
> ALT Gnome — открытое сообщество пользователей операционной системы ALT Regular Gnome. Платформы ALT Gnome:
>
> - [Wiki](https://alt-gnome.wiki)
> - [Telegram-канал](https://t.me/alt_gnome)
> - [Вконтакте](https://vk.com/alt_gnome)
> - [Rutube](https://rutube.ru/channel/32425669/)
> - [Платформа](https://plvideo.ru/@alt_gnome)
> - [Boosty](https://boosty.to/alt_gnome)
## Функционал
@@ -25,31 +24,37 @@ TODO: описать функционал
### Docker
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 build -t gnomik .
```
2. Запустите контейнер:
```shell
docker run -p 9000:9000 -v ./config.yaml:/app/config.yaml -v ./database:/app/database gnomik
```
Замените `./config.yaml` и `./database` на пути к локальным файлам конфигурации и пакам для базы данных.
### Вручную
1. Активируйте виртуальное окружение Gnomика:
```bash
poetry shell
```
```shell
poetry shell
```
2. Запустите бота:
```bash
python -m gnomik
```
```shell
python -m gnomik
```
## Конфигурация
Конфигурация бота находится в файле `config.yaml`.
## Модули
## Блоки
Список загружаемых модулей указан в файле `__main__.py`.
Список загружаемых блоков указан в файле `__main__.py`.