Skip to content

iapetusbob/ip

 
 

Repository files navigation

DOOK

Quick start

  1. Ensure you have Java 11 or above installed in your Computer.

  2. Download the latest dook.jar from here.

  3. Copy the file to the folder you want to use as the home folder for your DOOK.

  4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar dook.jar command to run the application.
    A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
    Ui

  5. Type the command in the command box and press Enter to execute it. e.g. typing help and pressing Enter will show all the commands at your disposal.
    Some example commands you can try:

    • list : Lists all contacts.

    • add todo Buy Carrots : Adds a task of type Todo called Buy Carrots to the list.

    • delete 3 : Deletes the 3rd task hown in the tasklist.

    • bye : Saves the current tasklist into the harddrive for next boot up of DOOK.

  6. Refer to the Features below for details of each command.

Features:

Viewing help : help

Brings users to the help page.

Format: help

Adding a task: add

Adds a task to the list.

Format: add <taskType> <task>

Examples:

add todo buy onions and garlic

add event Jack Birthday Party /from 10/10/23 1700 /to 10/10/23 2200

  • Types of Tasks supported:
    • Todo : The simplest type of task, all it needs is the name of the task.
    • add todo Buy Carrots
    • Deadline : A type of task with a due date, or a deadline. use /by to indicate the due date.
    • add deadline Return Book /by 10/10/2023 12:00 pm
    • Event : A task with a start date and time, and an end date and time. Use /from to indicate the start date and time, and /to for the end date and time.
    • add event Jack's Birthday Party /from 11/11/2023 1700 /to 11/11/2023 2200

Listing all tasks : list

Shows a list of all tasks in the list.

Format: list

Finding via keywords : find

Finds tasks in the list with sepcified keywords.

Format: find <keyword 1> <keyword 2> <...>

Examples :

find buy marked

  • Note : With find, the list of tasks shown with the relevant keywords are shown with their original indexing, i.e. the shown tasks after find-ing may not be in consecutive indexing, but their original positions in the list.

Marking tasks : mark

Marks the task at specified index as done.

Format : mark <index>

Examples :

mark 2

Unmarking : unmark

Unmarks the task with specified index.

Format : unmark 2

Deleting a person : delete

Deletes the specified task from the list.

Format: delete

Saving the data : bye

Saves the current list for next bootup of DOOK.

Format : bye

About

cs2103 individual project

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 97.0%
  • Shell 1.7%
  • Batchfile 1.3%