Skip to content
This repository was archived by the owner on Apr 25, 2022. It is now read-only.

Commit 99e9f7b

Browse files
committed
Update README.md
Added description for new features + update info for old ones.
1 parent ea6ba27 commit 99e9f7b

File tree

1 file changed

+52
-13
lines changed

1 file changed

+52
-13
lines changed

README.md

Lines changed: 52 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![Cover](./project_files/pics/Cover.png)
22
# About
3-
Чат бот для студентов
3+
Чат бот для студентов. Мой первый проект на Python, создан лишь для изучения языка.
44

55
# Основные функции
66
### Начало
@@ -50,27 +50,58 @@
5050
> /звонок <br>
5151
5252
## Препод
53-
### Поиск
53+
### Поиск имени
5454
Найдёт имя препода по названию его предмета.<br>
55-
> /препод **[Предмет]**<br>
55+
> /препод найти **[Предмет]**<br>
5656
57-
### Добавление
57+
### Добавление записи
5858
Если кого-то не хватает, то можно добавить самому.<br>
59-
> /добавь **[Препод=Предмет]**<br>
59+
> /препод добавить **[Препод=Предмет]**<br>
6060
61-
### Удаление
61+
### Удаление записи
6262
Накосячил, когда добавлял препода? Хотя бы эту ошибку можно исправить...<br>
63-
> /удали **[Препод=Предмет]**<br>
63+
> /препод удалить **[id препода (номер даётся в сообщении при поиске)]**<br>
64+
65+
Пример:<br>
66+
Команда **/препод Философия** возвращает следующее сообщение:<br>
67+
`🔍 Результаты поиска:`<br>
68+
`3. Философия (Иван Иванов Иванович)`<br>
69+
Для удаления этой записи (если она была добавлена Вами) нужно отправить:
70+
> /препод удалить **3** <br>
6471
6572
## Важное сообщение
6673
Сделать объявление на весь чат (@everyone).<br>
6774
> /важно **[Сообщение]**<br>
6875
76+
## Экзамен
77+
### Ближайший экзамен
78+
Выдаст ближайший экзамен в соответствии с учебной группой.<br>
79+
> /экзамен <br>
80+
81+
### Ближайшие несколько экзаменов
82+
Выдаст несколько ближайших экзаменов в соответствии с учебной группой.<br>
83+
> /экзамен **[количество]**<br>
84+
85+
### Добавить экзамен
86+
Добавит экзамен вашей учебной группе.<br>
87+
> /экзамен добавить **[ДД-ММ-ГГГГ ЧЧ:ММ=Название экзамена]** <br>
88+
89+
Пример:<br>
90+
> /экзамен добавить **31-12-2077 23:59=Философия** <br>
91+
92+
### Удалить экзамен
93+
Удалит экзамен вашей учебной группе.<br>
94+
> /экзамен удалить **[id экзамена (см. "/препод удалить")]** <br>
95+
6996
# Помощь
7097
### Карусель, карусель...
7198
Карусель с самым необходимым.<br>
7299
> /помощь <br>
73100
101+
### Все команды
102+
Отправит все команды (длинное сообщение + не все могут быть доступны).<br>
103+
> /команды <br>
104+
74105
# Misc.
75106
## Клавиатура бота
76107
### Показать клавиатуру
@@ -87,24 +118,32 @@
87118
88119
## Random reply
89120
Бот что-то отправит...<br>
90-
> sadbot <br>
121+
> /sadbot <br>
91122
92-
## Остановить работу бот (отключено)
123+
## Остановить работу бот
93124
Требуются права админа. Сохраняет анонимную статистику и убивает бота.
94-
> Стоп <br>
95-
> Stop <br>
96-
> Kill <br>
125+
> /kill
126+
127+
## Кастомные скрипты
128+
Доступ к консоли через чат с ботом.
129+
> /run **[команда]**
97130
98131
# Console commands
99-
Если вы хотите запустить бота у себя. <br>
132+
### Если вы хотите запустить бота у себя. <br>
133+
100134
`--initiate` Создаст пустую базу данных и добавит в неё group0, чтобы вы сразу могли внести изменения.
101135
Не забудьте отредактировать расписание звонков в groups. <br>
136+
102137
`--generate_template` Создаст пустой .xls файл, необходимый для регистрации новой группы.
103138
Отредактируйте его, заполнив туда ваше расписание для верхней и нижней недели в соответсвии с заголовком столбца.
104139
1 означает нижняя неделя, 2 — верхняя. <br>
140+
105141
`--register_new_group` Добавит новую группу в базу данных. Требуется .xls файл (см. выше). <br>
142+
106143
`--update_group` Обновит расписание и/или название группы <br>
144+
107145
`--start` Запустит бота. Не забудьте проверить config.py <br>
146+
108147
# Credits:
109148
#### Design
110149
defaulterror (Derek Clark): [Commando Font](https://www.dafont.com/commando.font) <br>

0 commit comments

Comments
 (0)