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

[TJ-Hoo] iP #190

Open
wants to merge 33 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
a1fb5b3
no message
TJ-Hoo Jan 25, 2023
50e9438
Revert "no message"
TJ-Hoo Jan 30, 2023
8f06dc1
no message
TJ-Hoo Jan 30, 2023
15e6f91
Revert "no message"
TJ-Hoo Jan 30, 2023
f19569e
Level 0
TJ-Hoo Jan 30, 2023
aeb3c02
Level 1
TJ-Hoo Jan 31, 2023
8b22744
Level 2
TJ-Hoo Jan 31, 2023
1feb6e5
Level 3
TJ-Hoo Feb 1, 2023
7c31d51
Level 4
TJ-Hoo Feb 1, 2023
1bf5e36
A-CodingStandard
TJ-Hoo Feb 9, 2023
3d6f6e3
A-CodingQuality
TJ-Hoo Feb 9, 2023
875ec03
Level-5
TJ-Hoo Feb 16, 2023
2f9f975
Level-6
TJ-Hoo Feb 22, 2023
6bdd653
Level-7
TJ-Hoo Feb 22, 2023
e1391de
Merge branch 'branch-level-7'
TJ-Hoo Feb 25, 2023
8206b33
Level-9
TJ-Hoo Feb 25, 2023
2e3fd7c
Merge pull request #1 from TJ-Hoo/branch-level-9
TJ-Hoo Feb 25, 2023
4375e13
A-JavaDoc
TJ-Hoo Feb 25, 2023
905f7d0
Merge pull request #2 from TJ-Hoo/branch-JavaDoc
TJ-Hoo Feb 25, 2023
1ebdea6
Update README.md
TJ-Hoo Feb 25, 2023
31322c7
Update README.md
TJ-Hoo Feb 25, 2023
3986655
no message
TJ-Hoo Feb 25, 2023
9c0ba57
Rename README.md to UserGuide
TJ-Hoo Feb 26, 2023
f221b77
Merge remote-tracking branch 'origin/master'
TJ-Hoo Feb 26, 2023
ce6d09e
Merge remote-tracking branch 'origin/master'
TJ-Hoo Feb 26, 2023
c25b455
Update README.md
TJ-Hoo Feb 26, 2023
f8faf8e
Update README.md
TJ-Hoo Feb 26, 2023
9366fd6
Update README.md
TJ-Hoo Feb 26, 2023
4eb7c4a
Minor Fixes
TJ-Hoo Feb 26, 2023
24afabf
Merge remote-tracking branch 'origin/master'
TJ-Hoo Feb 26, 2023
3f092ce
Minor improvements
TJ-Hoo Feb 28, 2023
dc79a03
Minor bug fixes
TJ-Hoo Feb 28, 2023
fd2c8f9
Minor fix
TJ-Hoo Mar 1, 2023
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
24 changes: 0 additions & 24 deletions README.md

This file was deleted.

57 changes: 57 additions & 0 deletions UserGuide
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Duke Task Manager
Duke is a task manager that helps users keep track of their daily tasks. Users can add, edit, delete, and search for tasks using the command-line interface. Duke uses a simple text file to store the tasks.
This guide will help you get started.

## Prerequisites
Before using Duke, please ensure that you have the following:
- Java 11 or later installed on your computer
- The Duke.jar file downloaded on your computer

## Getting Started
1. Download the Duke.jar file to your computer.
2. Open a terminal or command prompt and navigate to the directory where the Duke.jar file is located.
3. Run the following command to start Duke:

java -jar Duke.jar
4. If Duke is running properly, you should see a welcome message.

## Features
Duke currently supports the following features:

### Adding Tasks
To add a task, type one of the following commands followed by the task description:
- todo: adds a new todo task
- event: adds a new event task
- deadline: adds a new deadline task
For example:
todo buy groceries
event attend meeting /at 2022-03-01 10:00-12:00
deadline submit report /by 2022-03-05 23:59

### Listing Tasks
To list all the tasks currently in Duke, type the command list.

### Marking Tasks
To mark a task as done, type the command mark followed by the task number. For example:
mark 2

### Unmarking Tasks
To unmark a task as done, type the command unmark followed by the task number.
For example:
unmark 2

### Deleting Tasks
To delete a task, type the command delete followed by the task number. For example:
delete 2

### Finding Tasks
To find tasks containing a specific keyword, type the command find followed by the keyword. For example:
find groceries

### Exiting Duke
To exit Duke, type the command bye.

## Notes
- All tasks added to Duke are automatically saved to a file named "Duke.txt" in the same directory as the Duke.jar file.
- If the Duke.txt file already exists, Duke will load the tasks from the file when it starts.
- If an error occurs while Duke is running, an error message will be displayed.
68 changes: 52 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,65 @@
# User Guide
# Duke Task Manager
Duke is a task manager that helps users keep track of their daily tasks. Users can add, edit, delete, and search for tasks using the command-line interface. Duke uses a simple text file to store the tasks.
This guide will help you get started.

## Features
## Prerequisites
Before using Duke, please ensure that you have the following:
- Java 11 or later installed on your computer
- The Duke.jar file downloaded on your computer

### Feature-ABC
## Getting Started
1. Download the Duke.jar file to your computer.
2. Open a terminal or command prompt and navigate to the directory where the Duke.jar file is located.
3. Run the following command to start Duke:

Description of the feature.
java -jar Duke.jar
4. If Duke is running properly, you should see a welcome message.

### Feature-XYZ
## Features
Duke currently supports the following features:

Description of the feature.
### Adding Tasks
To add a task, type one of the following commands followed by the task description:
- todo: adds a new todo task
- event: adds a new event task
- deadline: adds a new deadline task

## Usage
For example:
todo borrow book
event project meeting /from Mon 2pm /to 4pm
deadline return book /by Sunday

### `Keyword` - Describe action
### Listing Tasks
To list all the tasks currently in Duke, type the command list.

Describe the action and its outcome.
### Marking Tasks
To mark a task as done, type the command mark followed by the task number.

Example of usage:
For example:
mark 2

`keyword (optional arguments)`
### Unmarking Tasks
To unmark a task as done, type the command unmark followed by the task number.

Expected outcome:
For example:
unmark 2

Description of the outcome.
### Deleting Tasks
To delete a task, type the command delete followed by the task number.

```
expected output
```
For example:
delete 2

### Finding Tasks
To find tasks containing a specific keyword, type the command find followed by the keyword.

For example:
find groceries

### Exiting Duke
To exit Duke, type the command bye.

## Notes
- All tasks added to Duke are automatically saved to a file named "Duke.txt" in the same directory as the Duke.jar file.
- If the Duke.txt file already exists, Duke will load the tasks from the file when it starts.
- If an error occurs while Duke is running, an error message will be displayed.
Empty file added duke.txt
Empty file.
20 changes: 20 additions & 0 deletions src/main/java/Deadline.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/**
Represents a task with a deadline.
Inherits from the Task class.
*/
public class Deadline extends Task {
protected String due;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use noun for variable. Perhaps dueDate is a better name for it.

/**
Constructs a Deadline object with the specified information and deadline.
@param info the description of the task.
@param due the deadline of the task.
*/
public Deadline(String info, String due) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps name is a better naming for the variable instead of info

super(info);
this.due = due;
}
@Override
public String toString(){
return "[D]" + super.toString() + "(by: " + due + ")";
}
}
Loading