Skip to content

zhxchd/C-3PO

 
 

Repository files navigation

User Guide of C-3PO

C-3PO is a droid for human cyborg relations.

Screenshot

Features

Add tasks - todo, events and deadlines

C-3PO can add different types of tasks to your task list, including:

  • Todo tasks that have a description for the task;
  • Event tasks that have a description, and a date when the events happen.
  • Deadline tasks that have a description and a due date.

Date processing

C-3PO can understand date representation of the format YYYY-MM-DD and compare multiple dates based on this feature. For date and time which cannot be understood by C-3PO, a raw string is used to store the date and time.

Mark tasks as done

C-3PO can mark tasks as done and display the task status in a list.

List all tasks

C-3PO is able to list all existing tasks.

Delete tasks

C-3PO can delete existing tasks from the task list.

Sort tasks by different properties

C-3PO can sort tasks by:

  • Name: in alphabetical order, from A to Z;
  • Kind: Deadline comes before Event before Todo;
  • Date: later understandable dates come before earlier dates, followed by string dates (Deadline before Event), and finally followed by Todo tasks.

Save data into local storage

C-3PO will store the data into local storage automatically after each operation. Every time when C-3PO starts, it automatically reads the local storage and loads previous data from it.

Usage

list - list all tasks

list command can list all the added tasks stored in the local database.

list

todo - add a todo task

todo command can add a new todo task to the task list.

todo DESCRIPTION

deadline - add a deadline task

deadline command add a new deadline task to the task list.

deadline DESCRIPTION /by DATE

DATE can be a string or in the format of YYYY-MM-DD. For the latter format, C-3PO will be able to understand the due date, while for the former format, C-3PO will directly save the date as a raw string.

event - add an event task

event command add a new deadline task to the task list.

event DESCRIPTION /at DATE

DATE can be a string or in the format of YYYY-MM-DD. For the latter format, C-3PO will be able to understand the date, while for the former format, C-3PO will directly save the date as a raw string.

done - mark a task as done

done command marks a task as done.

done INDEX

For a non-empty task list with n tasks, INDEX must be in the range of 1 to n (inclusive).

delete - delete a task

delete command deletes a task from the list.

delete INDEX

For a non-empty task list with n tasks, INDEX must be in the range of 1 to n (inclusive).

find - find tasks by keywords

find command searches for tasks with a specified keyword and prints a list of all searched tasks.

find KEYWORDS

sort - sort tasks by kind, name or date

sort command sorts the task list by their kinds, names or dates.

sort /by COMPARATOR

COMPARATOR can only be date, name or kind.

bye - save and exit

bye command shuts down the chat bot and exits in two seconds.

bye

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 97.0%
  • Shell 1.8%
  • Batchfile 1.2%