diff --git a/README.md b/README.md index e445994..0de5cbf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![Cover](./project_files/pics/Cover.png) # About -Чат бот для студентов +Чат бот для студентов. Мой первый проект на Python, создан лишь для изучения языка. # Основные функции ### Начало @@ -50,27 +50,58 @@ > /звонок
## Препод -### Поиск +### Поиск имени Найдёт имя препода по названию его предмета.
-> /препод **[Предмет]**
+> /препод найти **[Предмет]**
-### Добавление +### Добавление записи Если кого-то не хватает, то можно добавить самому.
-> /добавь **[Препод=Предмет]**
+> /препод добавить **[Препод=Предмет]**
-### Удаление +### Удаление записи Накосячил, когда добавлял препода? Хотя бы эту ошибку можно исправить...
-> /удали **[Препод=Предмет]**
+> /препод удалить **[id препода (номер даётся в сообщении при поиске)]**
+ +Пример:
+Команда **/препод Философия** возвращает следующее сообщение:
+`🔍 Результаты поиска:`
+`3. Философия (Иван Иванов Иванович)`
+Для удаления этой записи (если она была добавлена Вами) нужно отправить: +> /препод удалить **3**
## Важное сообщение Сделать объявление на весь чат (@everyone).
> /важно **[Сообщение]**
+## Экзамен +### Ближайший экзамен +Выдаст ближайший экзамен в соответствии с учебной группой.
+> /экзамен
+ +### Ближайшие несколько экзаменов +Выдаст несколько ближайших экзаменов в соответствии с учебной группой.
+> /экзамен **[количество]**
+ +### Добавить экзамен +Добавит экзамен вашей учебной группе.
+> /экзамен добавить **[ДД-ММ-ГГГГ ЧЧ:ММ=Название экзамена]**
+ +Пример:
+> /экзамен добавить **31-12-2077 23:59=Философия**
+ +### Удалить экзамен +Удалит экзамен вашей учебной группе.
+> /экзамен удалить **[id экзамена (см. "/препод удалить")]**
+ # Помощь ### Карусель, карусель... Карусель с самым необходимым.
> /помощь
+### Все команды +Отправит все команды (длинное сообщение + не все могут быть доступны).
+> /команды
+ # Misc. ## Клавиатура бота ### Показать клавиатуру @@ -87,24 +118,32 @@ ## Random reply Бот что-то отправит...
-> sadbot
+> /sadbot
-## Остановить работу бот (отключено) +## Остановить работу бот Требуются права админа. Сохраняет анонимную статистику и убивает бота. -> Стоп
-> Stop
-> Kill
+> /kill + +## Кастомные скрипты +Доступ к консоли через чат с ботом. +> /run **[команда]** # Console commands -Если вы хотите запустить бота у себя.
+### Если вы хотите запустить бота у себя.
+ `--initiate` Создаст пустую базу данных и добавит в неё group0, чтобы вы сразу могли внести изменения. Не забудьте отредактировать расписание звонков в groups.
+ `--generate_template` Создаст пустой .xls файл, необходимый для регистрации новой группы. Отредактируйте его, заполнив туда ваше расписание для верхней и нижней недели в соответсвии с заголовком столбца. 1 означает нижняя неделя, 2 — верхняя.
+ `--register_new_group` Добавит новую группу в базу данных. Требуется .xls файл (см. выше).
+ `--update_group` Обновит расписание и/или название группы
+ `--start` Запустит бота. Не забудьте проверить config.py
+ # Credits: #### Design defaulterror (Derek Clark): [Commando Font](https://www.dafont.com/commando.font)