Soot

---

Project Introduction

Soot is a Chatbot that uses the CLI to interact with its user, allowing its users to create a list of tasks that they have to complete.

This is an individual Java project that was done for the module, CS2113 Software Engineering & Object-Oriented Programming.

Table of Contents

• Project Introduction
• Booting Soot Up
• What Soot can do for YOU
  • View Soot's commands
  • Type of Tasks
  • Modifying your Task List
• Closing Soot

---

Booting Soot Up

1. Download the latest Soot.jar file here
2. Copy the file to the folder you want to use as the main Soot folder
3. Easily boot up Soot by navigating to the folder with the .jar file and run java -jar ip.jar

---

What Soot can do for YOU

TIPS for understanding how to use the commands:
- Variables in CAPITAL_LETTERS are parameters to be supplied by you, 
  otherwise copy the command format exactly
- An example input and output is provided for each command.
  Use this as a reference if you are not sure how to use the command.

View Soot's commands

If you are lost? Just key in one word and Soot will be there for you.

View all valid commands: help

Soot will let you know all commands I recognise!
Command Format: help

Input	Output
help	(see below)

full output >>>

here's all the commands i recognise:
    ~~~    
to add a task, remember to specify the task type
1. todo TASK_NAME
2. deadline TASK_NAME /by DUE_DATE
3. event TASK_NAME /from START_DATE /to END_DATE
    ~~~    
to modify ur task list:
- list (to view you list)
- done TASK_INDEX_IN_LIST (mark a task as done)
- unmark TASK_INDEX_IN_LIST (mark a task as undone)
- delete TASK_INDEX_IN_LIST (delete a task from your list)
- find KEYWORD_TO_FIND (find a specific word in your task list)
    ~~~    
still lost? don't worry, visit this link for more info
https://claribelho.github.io/ip/

Type of Tasks

Soot recognises 3 types of tasks - Todo, Deadline and Event. These tasks can be added to the list using the following commands:

1. Add a Todo task: todo

Soot will add a new task of type Todo to your task list.
Command Format: todo TASK_NAME

Input	Output
todo math	Okay! i've added to ur tasklist: >> [T][ ] math you currently have a total of 1 tasks in your list :)

2. Add a Deadline task: deadline

Soot will add a new task of type Deadline to your task list.
Command Format: deadline TASK_NAME /by DUE_DATE

Input	Output
deadline math /by tmr	Okay! i've added to ur tasklist: >> [D][ ] math (by: tmr!) you currently have a total of 1 tasks in your list :)

3. Add an Event task: event

Soot will add a new task of type Event to your task list.
Command Format: event TASK_NAME /from START_DATE /to END_DATE

Input	Output
event math /from tues /to wed	Okay! i've added to ur tasklist: >> [E][ ] math (from: tues ~~ to: wed!) you currently have a total of 1 tasks in your list :)

Modifying your Task List

Using Soot, you can do the following to your list:

List all your tasks out: list

Soot will look at the tasks you have added and lets you view it as a list.
Command Format: list

Input	Output
list	tasks to be done: 1. [T][ ] math

Mark a task as completed: done

Soot will find the task you are specifying and will mark it done.
Command Format: done TASK_INDEX_IN_LIST

Input	Output
done 1	good job! this task is marked as done now: >> math

Mark a task as uncompleted: unmark

Soot will find the task you are specifying and will mark it undone.
Command Format: unmark TASK_INDEX_IN_LIST

Input	Output
unmark 1	This task is now marked undone: >> math

Delete a task: delete

Soot will find the task you are specifying and will delete it from your list.
Command Format: delete TASK_INDEX_IN_LIST

Input	Output
delete 1	okay, i will remove this task from your list: >> [T][ ] math you currently have a total of 2 tasks in your list :)

Find a keyword in your tasks: find

Soot will find the keyword you are specifying within the task names of your list and will list these tasks to you.
Command Format: find KEYWORD_TO_FIND

Input	Output
find math	i found your word in these tasks: 1. [T][ ] math assignment 2. [T][ ] math problems

---

Closing Soot

Don't worry, whenever you are ready to go, Soot will save your task list to your device for future use.

All you have to say is bye :)

Closing Soot: bye

Command Format: bye

Input	Output
bye	Bye! Till the next time we meet... i've saved your list for future use <3

We hope to see you back on Soot soon.