Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Level 3 completed #77

Open
wants to merge 23 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions data/dukeData.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
E | 0 | kill batmanT | 0 | hi
215 changes: 206 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,217 @@
# User Guide

## Features
### Display help
Open the list of available commands that are supported by Duke

Keyword: `help`


### Create task
Creates a task with description only

Keyword: `todo`


### Create task with deadline
Creates a task with description and a time limit

Keyword: `deadline`


### Create event with timing
Creates an event with description, date and time

Keyword: `event`


### Mark task as done
Mark a task/deadline task/event as done

Keyword: `done`


### Display the list of tasks
Open the list of available tasks

Keyword: `list`


### Delete task
Delete a task/deadline task/event

Keyword: `delete`


### Clear all tasks
Delete all the tasks saved inside the memory

Keyword: `clear`


### Save changes
Save any changes made since starting up duke

Keyword: `save`


### Find task
Search for all tasks/deadline tasks/events that contains the keyword

Keyword: `find`


### Terminate program
Terminate the program

Keyword: `bye`

### Feature 1
Description of feature.

## Usage
### Display help
Enter the keyword `help`
#### Example of usage:
`help`
#### Expected outcome:
Duke supports the following commands

Please enter the keyword followed by details required in the <>

todo &lt;task details&gt; --------------------------- Create a new task

deadline &lt;task details&gt; /by: &lt;timing details&gt; - Create a new task with a time element

event &lt;event details&gt; /at: &lt;timing details&gt; --- Create a new event with a time element

done &lt;task number&gt; ---------------------------- Mark task as done

delete &lt;task number&gt; -------------------------- Delete task

list ------------------------------------------ List all available tasks and events

bye ------------------------------------------- Shutdown Duke


### Create task
Enter keyword `todo` followed by the description of the task to create a new incomplete task with that description.
#### Example of usage:
todo get eggs
#### Expected outcome:
The following task has been created:

1. [T][NotDone] get eggs

Total number of incomplete tasks: 1


### Create task with deadline
Enter the keyword `deadline`, the task description, keyword `/by`, and lastly the intended deadline, all on the same line
#### Example of usage:
deadline OCIP planning \by 20 Mar 2020 18:00
#### Expected outcome:
The following task has been created:

2. [D][NotDone] OCIP planning (by: 20 Mar 2020 18:00)

Total number of incomplete tasks: 2


### Create event with timing
Enter the keyword `event`, the event description, keyword `/at`, and lastly the intended date and time, all on the same line
#### Example of usage:
event attend open house /at 8 Mar 2020 12:00
#### Expected outcome:
The following task has been created:

3. [E][NotDone] attend open house (at: 8 Mar 2020 12:00)

Total number of incomplete tasks: 3


### Mark task as done
Enter the keyword `done` followed by the index number of the task (the index number could be checked using the list command)
#### Example of usage:
done 1
#### Expected outcome:
Nice! I've marked this task as done:

[Done] get eggs

Total number of incomplete tasks: 2


### Display the list of tasks
Enter the keyword `list`
#### Example of usage:
list
#### Expected outcome:
Here is a list of all your tasks:

1. [T][Done] get eggs

2. [D][NotDone] OCIP planning (by: 20 Mar 2020 18:00)

3. [E][NotDone] attend open house (at: 8 Mar 2020 12:00)

Total number of incomplete tasks: 2


### Delete task
Enter the keyword `delete` followed by the index number of the task (the index number could be checked using the list command)
#### Example of usage:
delete 1
#### Expected outcome:
get eggs has been deleted!


### Clear all tasks
Enter the keyword `clear`
#### Example of usage:
clear
#### Expected outcome:
Your changes have been saved successfully


### Save changes
Enter the keyword `save`
#### Example of usage:
save
#### Expected outcome:
Warning! This command will delete all your tasks, proceed?(Y/N)

If user enters `Y`:

Your tasks have been cleared


If user enters `N`:

Command has been cancelled


### Find task
Enter the keyword `find`, followed by the search term
#### Example of usage:
find OCIP
#### Expected outcome:
Here are the relevant tasks in your list:

1. [D][NotDone] OCIP planning (by: 20 Mar 2020 18:00)


### Terminate program
Enter the keyword `bye`, then enter "Y" to save changes, "N" to exit without saving
#### Example of usage:
`bye`
#### Expected outcome:
Would you like to save your changes?(Y/N)

### `Keyword` - Describe action
If user enters `Y`:

Describe action and its outcome.
Your changes have been saved successfully

Example of usage:
Bye. Hope to see you again soon!

`keyword (optional arguments)`

Expected outcome:
If user enters `N`:

`outcome`
Bye. Hope to see you again soon!
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
theme: jekyll-theme-time-machine
2 changes: 2 additions & 0 deletions src/.idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions src/.idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions src/.idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions src/.idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

91 changes: 91 additions & 0 deletions src/main/java/.idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added src/main/java/Duke.class
Binary file not shown.
Loading