Skip to content

dillontkw/ip

 
 

Repository files navigation

Cynthius User Guide

This is a greenfield Java project based on the generic project called Project Duke.
The result of this project is a personal assistant chat-bot named Cynthius capable of keeping track of tasks and contacts given by the user.

Features

  • Managing tasks(todo, deadline, event)
  • Autosave
  • Manage contacts

Usage


Help: help

Displays a guide of all commands.


Adding a todo: todo

Adds a todo task to the task list.

Format: todo TASK

Example: todo homework

Expected outcome:

Information added successfully!

Adding an event: event

Adds an event task to the task list.

Format: event TASK /at TASK_LOCATION

Example: event birthday party /at Calvin's house

Expected outcome:

Information added successfully!

Adding a deadline: deadline

Adds a deadline task to the task list.

Format: deadline TASK /by TASK_DATE_TIME

Example: deadline ES2660 draft /by 16/9

Expected outcome:

Information added successfully!

Adding a contact: contact

Adds a contact to the contact list.

Format: contact NAME (/about NAME_DESCRIPTION)

Do note that (/about NAME_DESCRIPTION) is optional

Example: contact Calvin /about orbital partner

Expected outcome:

Information added successfully!

Deleting a task or contact: delete

Removes a task/contact from the list.

Format: delete CONTACT/TASK INDEX

For CONTACT/TASK, c represents deleting from the contact list while t represents deleting from the task list

Example 1: delete c 1 (delete first contact)

Example 2: delete t 3 (delete third task)

Expected outcome:

Information deleted successfully!

Mark task as done: done

Marks a task in task list as done.

Format: done INDEX

Example: done 2 (marks second task in task list as done)

Expected outcome:

Task marked as done!

Finding tasks or contacts: find

Searches for task(s) and contact(s) that contain the keyword(s)

Format: find KEYWORD(S)

Example: find k3soju

Expected outcome (if tasks/contacts were found):

Here are your tasks:
[T][ ] twitch sub to k3soju

Here are your contacts:
[C] k3soju (detail: twitch sub)

Expected outcome (if NO tasks/contacts were found):

No tasks found!

No contacts found!

List tasks and contacts: list

Lists all tasks/contacts currently saved.

Format: list

Example: list

Expected outcome:

Here are your tasks:
[T][ ] homework
[D][X] CS2103T review (by: Sep 15 2021)
[E][ ] sleep (at: home)

Here are your contacts:
[C] Calvin (detail: im sponsored by him)

Saving data

Cynthius automatically saves any changes made once a user has inputted a valid command.


Exiting Cynthius: bye

Closes Cynthius.

Format: bye

Example: bye

Expected outcome:

Bye. Hope to see you again soon!

Command summary

Command Format Example
Add a ToDo todo TASK todo homework
Add an Event event TASK /at TASK_LOCATION event birthday party /at Calvin's house
Add a Deadline deadline TASK /by TASK_DATE_TIME deadline ES2660 draft /by 16/9
Add a Contact contact NAME (/about NAME_DESCRIPTION) contact Calvin /about orbital partner
Delete Task/Contact delete CONTACT/TASK INDEX delete c 1, delete t 3
Mark task as Done done INDEX done 1, done 2
Find Tasks/Contacts find KEYWORD(S) find k3soju
List All Tasks/Contacts list list
Help help help
Exit bye bye

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Java 97.0%
  • Shell 1.4%
  • Other 1.6%