Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A-MoreOOP #314

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 149 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,161 @@
# User Guide
# User Guide

## Features

### Feature 1
Description of feature.
### 1. Add Todo
Add a todo task to your task list.

### 2. Add Deadline
Add a deadline task to your task list with relevant time.

### 3. Add Event
Add an event to your task list with relevant time.

### 4. Mark task as Done
Mark a task in your task list as done.

### 5. List all tasks
List out all tasks in your task list in order.

### 6. Delete task
Delete a task from your task list.

### 7. Find task
Find tasks containing any form of a keyword.

### 8. Save task list
Save your task list to a .txt file.

### 8. Save task list
Load your task list from a .txt file.


## Usage

### `Keyword` - Describe action
### `todo <task description>` - Add a Todo task

Add a Todo task to your task list.

Example of usage:

`todo read book`

Expected outcome:

`____________________________________________________________
Got it. I've added this task: `
`[T][✗] read book`
`Now you have 1 tasks in the list.`
`____________________________________________________________`

### `event <task description> /at <date>` - Add an Event

Add an Event task to your task list with relevant time.

Example of usage:

`event meeting /10am`

Expected outcome:

`____________________________________________________________
Got it. I've added this task: `
`[E][✘] meeting (10am)`
`Now you have 2 tasks in the list.`
`____________________________________________________________`

### `deadline <task description> /by <date>` - Add a Deadline

Add a Deadline task to your task list.

Example of usage:

`deadline Assignment 2 /Monday 2359`

Expected outcome:

`____________________________________________________________
Got it. I've added this task: `
`[D][✗] Assignment 2 (Monday 2359)`
`Now you have 3 tasks in the list.`
`____________________________________________________________`




Describe action and its outcome.

Example of usage:

`keyword (optional arguments)`
### `done <task index>` - Mark task as done

Mark a task in your task list as done.

Example of usage:

`done 1`

Expected outcome:

`____________________________________________________________
Nice! I've marked this task as done: `
`[[T][✓] read book`
`____________________________________________________________`

### `list` - List all tasks

List all tasks in your task list.

Example of usage:

`list`

Expected outcome:

`____________________________________________________________
Here are the tasks in your list: `
`1. [T][✓] read book`
`2. [E][✘] meeting (10am)`
`3. [D][✘] Assignment 2 (Monday 2359)`
`____________________________________________________________`

### `delete <task index>` - Delete a task

Delete a task from your task list.

Example of usage:

`delete 1`

Expected outcome:

`outcome`
`____________________________________________________________`
`Removed: [T][✓] read book`
`Now you have 2 task(s) in your list`
`____________________________________________________________`

### `find <keyword>` - Find tasks

Find tasks with matching keyword.

Example of usage:

`find read`

Expected outcome:


`Here are the matching tasks in your list: `
`1. [D][✘] Go through lecture readings (Tuesday before lecture)`
`2. [E][✘] Reading habit fair (Tuesday 10pm)`

### `save` - Save task list

Save task list to .txt file.

Example of usage:

`save`

Expected outcome:

`Successfully saved to file!`

11 changes: 11 additions & 0 deletions src/main/java/Deadline.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
public class Deadline extends Task {
public Deadline(String description, String deadline) {
super(description);
this.date=deadline;
}

@Override
public String toString() {
return "[D]" + super.toString() + "(" + this.date + ")";
}
}
Loading