From c4a2a3aeb0ad12074c7da6a95138f6f68acd59c6 Mon Sep 17 00:00:00 2001 From: Xunyi <73570047+XunyiiZ@users.noreply.github.com> Date: Fri, 4 Mar 2022 17:19:51 +0800 Subject: [PATCH] Update README.md --- README.md | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 8715d4d91..f76aff5e4 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,23 @@ -# Duke project template +# Smart XiaoAi TongXue -This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it. +This is a task management Java project. It's named after the Smart XiaoAi TongXue. Given below are instructions on how to use it. -## Setting up in Intellij +## list +list all tasks in the task list +## todo {task description} +add Todo task +## deadline {task description} /by {time} +add Deadline +## Event {task description} /at {time} +add Event +## mark {index} +mark task +## unmark {index} +unmark task +## delete {index} +delete task from list +## find {text} +find matching tasks containing the {text} +## bye +exit the program -Prerequisites: JDK 11, update Intellij to the most recent version. - -1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first) -1. Open the project into Intellij as follows: - 1. Click `Open`. - 1. Select the project directory, and click `OK`. - 1. If there are any further prompts, accept the defaults. -1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).
- In the same dialog, set the **Project language level** field to the `SDK default` option. -3. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output: - ``` - Hello from - ____ _ - | _ \ _ _| | _____ - | | | | | | | |/ / _ \ - | |_| | |_| | < __/ - |____/ \__,_|_|\_\___| - ```