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

Philip Chang // iP PR #124

Open
wants to merge 19 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
Binary file added Individual Project.jar
Binary file not shown.
139 changes: 125 additions & 14 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,141 @@
# Duke User Guide
# PlopBot User Guide

// Update the title above to match the actual product name
![PlopBot Screenshot](Screenshot.png)

// Product screenshot goes here
PlopBot is a user-friendly task management application that helps you keep track of your to-dos, deadlines, and events. With its simple command-line interface, you can easily add, view, and manage your tasks.

// Product intro goes here

## Adding deadlines
## Adding Tasks

// Describe the action and its outcome.
### 1. Adding To-Dos

// Give examples of usage
To add a simple to-do task:

Example: `keyword (optional arguments)`
todo <task description>

Example: 'todo Buy Groceries'

// A description of the expected outcome goes here
```
Expected output:
Added: [T][ ] Buy Groceries
You now have 1 tasks in the list.
```

### 2. Adding Deadlines

To add a task with a deadline:

deadline <task desscription> /by <date>

Example: 'deadline Submit Report /by 2024-01-01'

```
Expected output:
Added: [D][ ] Submit Report (by: 2024-01-01)
You now have 2 tasks in the list.
```

Note: Dates can be in the format 'YYYY-MM-DD', or day names like 'Monday', 'Tue', etc.

### 3. Adding Events

To add an event:

event <task description> /from <start time> /to <end time>

Example: 'event Team meeting /from 2023-06-10 14:00 /to 2023-06-10 15:30'

```
expected output
Expected output:
Added: [E][ ] Team meeting (from: 2023-06-10 14:00 to: 2023-06-10 15:30)
You now have 3 tasks in the list.
```

## Feature ABC

// Feature details
## Viewing Tasks

To view all your tasks, simply write:

list

```
Expected output:
Here are the tasks in your list:
1.[T][ ] Buy Groceries
2.[D][ ] Submit Report (by: 2024-01-01)
3.[E][ ] Team meeting (from: 2023-06-10 14:00 to: 2023-06-10 15:30)
```


## Feature XYZ
## Marking Tasks as Complete

// Feature details
To mark a task as 'done':

mark <task number>

Example: 'mark 1'

```
Expected output:
I've marked this task as done:
[T][X] Buy Groceries
```


## Unmarking Tasks

To unmark a task:

unmark <task number>

Example: 'unmark 1'

```
Expected output:
I've unmarked this task:
[T][ ] Buy Groceries
```


## Deleting Tasks

To delete a task:

delete <task number>

Example: 'delete 2'

```
Expected output:
Removed: [D][ ] Submit Report (by: 2024-01-01)
You now have 2 tasks in the list.
```


## Finding Tasks

To find tasks containing a keyword:

find <keyword>

Example: 'find meeting'

```
Expected output:
Here are the matching tasks in your list:
1.[E][ ] Team meeting (from: 2023-06-10 14:00 to: 2023-06-10 15:30)
```


## Exiting PlopBot

To exit the program, simply write one of the following:

bye
exit
quit

```
Expected output:
Thank you for choosing PlopBot. Have a great day!
```
Binary file added docs/Screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
10 changes: 0 additions & 10 deletions src/main/java/Duke.java

This file was deleted.

3 changes: 3 additions & 0 deletions src/main/java/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Manifest-Version: 1.0
Main-Class: PlopBot

Loading