Skip to content

Cao-Zeyu/ip

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

User Guide

Introduction

Duke is an application that is designed to help users to keep track of different types of tasks (i.e. todos, deadlines, events).

Quick start

  1. Ensure you have Java 11 or above installed in your computer.
  2. Download the latest ... from... .
  3. Copy the file to the folder you want to use as the howe folder for your Duke.
  4. Double-click the file to start the app.

Features

Providing help information: help

  • Displays all the valid input commands for the user to understand how to use Duke.
  • Format: help
  • Example of expected output:
___________________________________________
	Here are some available commands and their corresponding input format: 

	Listing all the tasks: `list` 
	Format: `list`

	Adding a todo task: `todo` 
	Format: `todo TASK`

	Adding a deadline task: `deadline` 
	Format: `deadline TASK /by BYTIME`

	Adding an event task: `event` 
	Format: `event TASK /by ATTIME`

	Marking a task as done: `done` 
	Format: `done INDEX`

	Deleting a task: `delete` 
	Format: `delete INDEX`

	Finding a task: `find` 
	Format: `find KEYWORD`

	Exiting Duke: `bye` 
	Format: `bye`
	___________________________________________

Listing all the tasks: list

  • Displays the list of all recorded tasks.
  • Format: list
  • Example of expected output:
	___________________________________________
	Here are the tasks in your list: 
	1. [T][✘] read a book
	2. [D][✘] return the book (by: 10 Oct)
	3. [E][✘] group meeting (at: 11am Thursday)
	___________________________________________

Adding a todo task: todo

  • Adds a todo task which has no time limit to finish.
  • Format: todo TASK
  • Example: todo read a book
  • Example of expected output:
	___________________________________________
	Got it. I've added this task: 
	   [T][✘] read a book
	Now you have 1 tasks in the list. 
	___________________________________________

Adding a deadline task: deadline

  • Adds a deadline task which has to be done by a certain time.
  • Format:deadline TASK /by BYTIME
  • Example: deadline return the book /by 10 Oct
  • Example of expected output:
	___________________________________________
	Got it. I've added this task: 
	   [D][✘] return the book (by: 10 Oct)
	Now you have 5 tasks in the list. 
	___________________________________________

Adding an event task: event

  • Adds an event task which will happen at a certain time.
  • Format:event TASK /by ATTIME
  • Example: event group meeting /at 11am Thursday
  • Example of expected output:
	___________________________________________
	Got it. I've added this task: 
	   [E][✘] group meeting (at: 11am Thursday)
	Now you have 6 tasks in the list. 
	___________________________________________

Marking a task as done: done

  • Marks a certain task indicated by the user as done.
  • Format: done INDEX
  • Example: done 1
  • Example of expected output:
	___________________________________________
	Nice! I've marked this task as done: 
	   [T][✓] read a book
	___________________________________________

Deleting a task: delete

  • Deletes a certain task indicated by the user.
  • Format: delete INDEX
  • Example: delete 4
  • Example of expected output:
	___________________________________________
	Noted. I've removed this task: 
	   [T][✘] take a walk
	Now you have 3 tasks in the list.
	___________________________________________

Finding a task: find

  • Finds the tasks that contains the certain keyword given by the user.
  • Format: find KEYWORD
  • Example: find book
  • Example of expected output:
	___________________________________________
	Here are the matching tasks in your list: 
	1. [T][✓] read a book
	2. [D][✘] return the book (by: 10 Oct)
	___________________________________________

Exiting Duke: bye

  • Exits Duke.
  • Format: bye
  • Example of expected output:
	___________________________________________
	Bye. Hope to see you again soon!
	___________________________________________

About

Starter code for the Duke project

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Java 94.6%
  • Shell 3.1%
  • Batchfile 2.3%