Browse Source

Обновить 'README.md'

a_and_a 2 tuần trước cách đây
mục cha
commit
a265d4b4b9
1 tập tin đã thay đổi với 53 bổ sung1 xóa
  1. 53 1
      README.md

+ 53 - 1
README.md

@@ -1,2 +1,54 @@
-# pm04
 
+
+# Аннотация
+
+Программа «Учёт тренировок спортсменов» предназначена для автоматизации работы спортивного клуба. Она позволяет вести учёт пользователей (спортсменов), тренеров, абонементов, тренировок и залов. Программа реализована в виде консольного приложения на C# с подключением к удалённой базе данных PostgreSQL.
+# Введение
+
+## Основные возможности программы:
+
+- Добавление, просмотр, редактирование и удаление пользователей
+- Добавление и просмотр тренировок
+- Поиск пользователей по фамилии
+- Автоматическое списание тренировок при добавлении занятия
+- Проверка правильности ввода телефона (11 цифр)
+- Экспорт результатов поиска в CSV-файл
+# Назначение и условия применения
+
+Программа предназначена для администраторов и тренеров спортивных клубов, которые хотят вести учёт своих клиентов и их тренировок.
+
+**Условия применения:**
+- Наличие установленного .NET 8.0 Runtime
+- Наличие подключения к интернету
+- Наличие PostgreSQL клиента (для работы с libpq)
+- Доступ к серверу БД `edu-pg.itiscaf.ru`
+# Установка
+
+- Скачать архив с программой или склонировать репозиторий
+- Убедиться, что установлен .NET 8.0
+- Открыть папку с проектом в командной строке
+- Выполнить команду `dotnet build -c Release`
+- Скопировать файлы из `bin\Release\net8.0\` в папку `C:\TrainingApp`
+- Запустить программу через `C:\TrainingApp\pm_11.exe`
+
+Для автоматической установки можно использовать `install.bat`, который выполнит все шаги.
+# Описание операций
+
+1. **Показать всех пользователей** – выводит список всех зарегистрированных спортсменов с их данными.
+2. **Добавить пользователя** – запрашивает ФИО, телефон, абонемент и автоматически подставляет остаток тренировок из базы.
+3. **Добавить тренировку** – создаёт новую тренировку и автоматически списывает одно занятие из абонемента пользователя.
+4. **Редактировать пользователя** – изменяет телефон, остаток тренировок и дату окончания абонемента.
+5. **Удалить пользователя** – удаляет пользователя и все его тренировки из базы.
+6. **Поиск пользователей** – ищет по фамилии и сохраняет результат в CSV-файл.
+# Термины и сокращения
+
+| Термин | Сокращение | Описание |
+|--------|------------|----------|
+| Абонемент | - | Право на посещение определённого количества тренировок в течение заданного срока |
+| Пользователь | - | Спортсмен, который купил абонемент и посещает тренировки |
+| Тренер | - | Сотрудник, проводящий тренировки |
+| Тренировка | - | Занятие, которое проводит тренер для одного или нескольких пользователей |
+| Тренировочный зал | - | Помещение, где проводится тренировка |
+| БД | База данных | PostgreSQL, в которой хранятся все данные системы |
+| CSV | Comma-Separated Values | Формат файла для экспорта данных с разделителем-запятой |
+| .NET | - | Платформа для запуска приложения |