Skip to content

Commit

Permalink
Edited Readme user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
eliotlee68 committed Feb 20, 2024
1 parent c4cf3ea commit bcd6307
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 20 deletions.
39 changes: 19 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# Duke project template
# AaronBot User Guide
Welcome to the user guide for aaronbot!!

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.
## Viewing the list
Simply type `show list` to view the task list

## Setting up in Intellij
## Adding Tasks
Simply type `add` followed by one of three tasks
- `TODO`: Type `add todo [task description]`
- `EVENT`: Type `add event [task description] /from [start date] /to [end date]`
- `DEADLINE`: Type `add deadline [task description] /by [due date]`

Prerequisites: JDK 11, update Intellij to the most recent version.
## Marking/Unmarking Tasks
In order to mark/unmark a task as done, simply type `mark/unmark [index of task to be marked]`

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
____ _
| _ \ _ _| | _____
| | | | | | | |/ / _ \
| |_| | |_| | < __/
|____/ \__,_|_|\_\___|
```
## Deleting Tasks
In order to delete a task, simply type `delete [index of task to be deleted]`

## Snoozing tasks
In order to snooze a deadline/event task, type `snooze [index of task to be snoozed]` to delay it by 3 days

## Exiting the program
In order to exist the program, simply type `bye`
Empty file removed TaskList.txt
Empty file.

0 comments on commit bcd6307

Please sign in to comment.