Create README.md

Author: denis-bush

README.md

@@ -0,0 +1,44 @@
+<h1>О программе</h1>
+Бот "Симулятор Казино" создан в рамках курсовой работы по дисциплине "Технологии и методы программирования" в учебных целях. Данный бот не является коммерческим проектом и не нарушает действующего законодательства РФ. 
+
+Проект создан на языке Python с использованием API "pyTelegramBotAPI" и настроен для работы на удалённом сервере платформы Heroku, что позволяет ему автономно функционировать в Telegram. Для оформления интерфейса и визуализации игрового процесса используются различные символы Юникода, в том числе Эмодзи. 
+
+Для бота в программном виде реализованы две игры: "Кости" и "Слот-машина", функционирующие по общему алгоритму. В данных играх пользователь может задать свою ставку и сделать ход, результат которого просчитывается с помощью функции <i>randint</i>, после чего заработанные игровые очки начисляются на счёт пользователя (или списываются с него, в случае проигрыша).
+
+В проекте используется простейший метод хранения данных различных пользователей в виде словаря "DATABASE", с доступом по уникальному идентификатору пользователя user ID, регистрация пользователя происходит при начале работы с ботом (сразу после ввода команды "/start"). Это обеспечивает, в теории, возможность одновременной работы бота с несколькими пользователями в Telegram (в случае, если этому не помешает задержка программы/сервера), а также хранение и вывод игровой статистики пользователя. Пользователь может запросить удаление своего профиля, в результате чего его данные будут удалены из базы, и он сможет повторно пройти процедуру регистрации.
+
+Дополнительный функционал бота - вывод справочной информации из внешнего текстового файла.
+
+<h2>Пример работы бота:</h2>
+
+Регистрация нового пользователя
+
+<img src="https://github.com/denis-bush/casinosim-bot/blob/master/Screenshots/1.jpg" height="700"/> 
+
+Запуск игры в "Кости"
+
+<img src="https://github.com/denis-bush/casinosim-bot/blob/master/Screenshots/2.jpg" height="700"/>
+
+Завершение игры и вывод итогового результата
+
+<img src="https://github.com/denis-bush/casinosim-bot/blob/master/Screenshots/3.jpg" height="700"/> 
+
+Таблица выплат "Слот-машины"
+
+<img src="https://github.com/denis-bush/casinosim-bot/blob/master/Screenshots/4.jpg" height="700"/>
+
+Игра в "Слот-машину"
+
+<img src="https://github.com/denis-bush/casinosim-bot/blob/master/Screenshots/5.jpg" height="700"/> 
+
+Вывод статистики профиля
+
+<img src="https://github.com/denis-bush/casinosim-bot/blob/master/Screenshots/6.jpg" height="700"/>
+
+Вывод справочной информации
+
+<img src="https://github.com/denis-bush/casinosim-bot/blob/master/Screenshots/7.jpg" height="700"/> 
+
+Удаление профиля пользователя
+
+<img src="https://github.com/denis-bush/casinosim-bot/blob/master/Screenshots/8.jpg" height="700"/>