Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
XunyiiZ authored Mar 4, 2022
1 parent 8f65cf8 commit c4a2a3a
Showing 1 changed file with 20 additions and 21 deletions.
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).<br>
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
____ _
| _ \ _ _| | _____
| | | | | | | |/ / _ \
| |_| | |_| | < __/
|____/ \__,_|_|\_\___|
```

0 comments on commit c4a2a3a

Please sign in to comment.