Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fxe025 authored Mar 6, 2024
1 parent 35ef299 commit 8082696
Showing 1 changed file with 54 additions and 3 deletions.
57 changes: 54 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Duke project template
# Chatbot Battch User Guide

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 chatbot built based on the Project Duke template. Given below are instructions on how to use it.

## Setting up in Intellij

Expand All @@ -16,7 +16,58 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
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! I'm Duke
Hello! I'm Battch
What can I do for you?
____________________________________________________________
```

## Launch Battch Using JAR file

1. Copy the jar file into an empty folder.
2. Open a command window in that folder.
3. Run the command `java -jar {filename}.jar` e.g., `java -jar Duke.jar` (i.e., run the command in the same folder as the jar file).

## Features

Enter a line of text adds the item to the list. You should see somethind like the below as the output:
```
read book
____________________________________________________________
added: read book
Now you have 1 tasks in the list.
____________________________________________________________
```

Command List:
1. `list`: print all existing tasks in the list.
2. `mark INDEX_NUMBER`: mark the task indicated by the index as Done:
```
mark 1
____________________________________________________________
Nice! I've marked this task as done:
[X] read book
____________________________________________________________
```
3. `unmark INDEX_NUMBER`: mark the task indicated by the index as Not Done:
```
unmark 1
____________________________________________________________
OK, I've marked this task as not done yet:
[ ] read book
____________________________________________________________
```
4. `todo DESCRIPTION`: add a todo task.
5. `deadline DESCRIPTION [/by DUE_DATE]`: add a task that need to be done before a specific date/time.
6. `event DESCRIPTION [/from START_DATE] [/to END_DATE]`: add a task that start at a specific date/time and ends at a specific date/time.
7. `delete INDEX_NUMBER`: remove the task indicated by the index from the list.

Notes about the command format:

Words in UPPER_CASE are the parameters to be supplied by the user.
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as add n/John Doe.

Items in square brackets are optional.
e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.

Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
e.g. if the command specifies `help 123`, it will be interpreted as `help`.

0 comments on commit 8082696

Please sign in to comment.