-
Notifications
You must be signed in to change notification settings - Fork 200
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
TJ-Hoo
wants to merge
33
commits into
nus-cs2113-AY2223S2:master
Choose a base branch
from
TJ-Hoo:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
[TJ-Hoo] iP #190
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
a1fb5b3
no message
TJ-Hoo 50e9438
Revert "no message"
TJ-Hoo 8f06dc1
no message
TJ-Hoo 15e6f91
Revert "no message"
TJ-Hoo f19569e
Level 0
TJ-Hoo aeb3c02
Level 1
TJ-Hoo 8b22744
Level 2
TJ-Hoo 1feb6e5
Level 3
TJ-Hoo 7c31d51
Level 4
TJ-Hoo 1bf5e36
A-CodingStandard
TJ-Hoo 3d6f6e3
A-CodingQuality
TJ-Hoo 875ec03
Level-5
TJ-Hoo 2f9f975
Level-6
TJ-Hoo 6bdd653
Level-7
TJ-Hoo e1391de
Merge branch 'branch-level-7'
TJ-Hoo 8206b33
Level-9
TJ-Hoo 2e3fd7c
Merge pull request #1 from TJ-Hoo/branch-level-9
TJ-Hoo 4375e13
A-JavaDoc
TJ-Hoo 905f7d0
Merge pull request #2 from TJ-Hoo/branch-JavaDoc
TJ-Hoo 1ebdea6
Update README.md
TJ-Hoo 31322c7
Update README.md
TJ-Hoo 3986655
no message
TJ-Hoo 9c0ba57
Rename README.md to UserGuide
TJ-Hoo f221b77
Merge remote-tracking branch 'origin/master'
TJ-Hoo ce6d09e
Merge remote-tracking branch 'origin/master'
TJ-Hoo c25b455
Update README.md
TJ-Hoo f8faf8e
Update README.md
TJ-Hoo 9366fd6
Update README.md
TJ-Hoo 4eb7c4a
Minor Fixes
TJ-Hoo 24afabf
Merge remote-tracking branch 'origin/master'
TJ-Hoo 3f092ce
Minor improvements
TJ-Hoo dc79a03
Minor bug fixes
TJ-Hoo fd2c8f9
Minor fix
TJ-Hoo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; | ||
/** | ||
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) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 + ")"; | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.