diff --git a/todo/CHANGELOG.md b/CHANGELOG.md similarity index 100% rename from todo/CHANGELOG.md rename to CHANGELOG.md diff --git a/README.md b/README.md index 10b0521..6955372 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,27 @@ -# Todo App +# TodoApp -Консольное приложение для управления списком задач, разработанное на Java в процессе изучения языка. +## Описание +TodoApp - это консольное приложение для управления списком задач, разработанное на Java в качестве учебного проекта. Приложение позволяет создавать, просматривать, отмечать как выполненные и удалять задачи через интерфейс командной строки. -## Описание проекта +## Требования +- Java 24 или выше +- Maven 3.8.x или выше -Todo App — это консольное приложение, которое позволяет пользователю создавать, просматривать и управлять списком задач. Приложение поддерживает полный цикл работы с задачами: создание новых задач, изменение их статуса (начать выполнение, отметить как завершенные или отмененные) и просмотр полного списка задач. - -## Возможности - -- Создание новых задач с названием и описанием -- Управление статусом задач: - - Новая задача - - В процессе выполнения - - Завершена - - Отменена -- Просмотр списка всех задач -- Цветовая индикация статуса задач в консоли -- Защита от некорректного ввода пользователя +### Доступные команды +- `create <название_задачи>` - Создать новую задачу +- `list` - Показать список всех задач +- `complete ` - Отметить задачу как выполненную +- `delete ` - Удалить задачу +- `exit` - Выйти из приложения ## Структура проекта +- `model` - Модели данных (Task, SimpleTask) +- `repo` - Репозитории для хранения задач +- `service` - Бизнес-логика +- `cli` - Компоненты интерфейса командной строки -Проект организован на основе Maven и содержит следующие классы: - -- **TodoApp** — основной класс приложения с главным методом, пользовательским интерфейсом и менеджером задач -- **Task** — класс, представляющий задачу, с методами для управления её статусом -- **TaskStatus** — перечисление (enum) доступных статусов задачи с возможностью цветового оформления - -## Технологии - -- Java 24 -- Maven для управления сборкой проекта - -## Запуск приложения - -### Требования -- JDK 24 или выше -- Maven 3.6+ - -### Компиляция и запуск - -```bash -# Клонировать репозиторий -git clone https://github.com/kamask/todo-app.git -cd todo-app - -# Скомпилировать проект -mvn clean package - -# Запустить приложение -java -jar target/todo-1.0-SNAPSHOT.jar -``` - -## Использование - -После запуска приложения вы увидите главное меню: - -``` -┌──────────────────────────┐ -| [1] Добавить дело | -| [2] Список дел | -| | -| [0] Выйти из программы | -└──────────────────────────┘ -``` - -- Выберите **1** для создания новой задачи -- Выберите **2** для просмотра списка всех задач -- Выберите **0** для выхода из программы +## Версии +Актуальная версия: 2.0 ## Лицензия - -Этот проект распространяется под лицензией MIT. \ No newline at end of file +[MIT](LICENSE) \ No newline at end of file diff --git a/todo/README.md b/todo/README.md deleted file mode 100644 index 6955372..0000000 --- a/todo/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# TodoApp - -## Описание -TodoApp - это консольное приложение для управления списком задач, разработанное на Java в качестве учебного проекта. Приложение позволяет создавать, просматривать, отмечать как выполненные и удалять задачи через интерфейс командной строки. - -## Требования -- Java 24 или выше -- Maven 3.8.x или выше - -### Доступные команды -- `create <название_задачи>` - Создать новую задачу -- `list` - Показать список всех задач -- `complete ` - Отметить задачу как выполненную -- `delete ` - Удалить задачу -- `exit` - Выйти из приложения - -## Структура проекта -- `model` - Модели данных (Task, SimpleTask) -- `repo` - Репозитории для хранения задач -- `service` - Бизнес-логика -- `cli` - Компоненты интерфейса командной строки - -## Версии -Актуальная версия: 2.0 - -## Лицензия -[MIT](LICENSE) \ No newline at end of file