Skip to content
Open

PR #96

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
46 changes: 46 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
plugins {
id 'java'
id 'application'
id 'checkstyle'
id 'com.github.johnrengelman.shadow' version '5.1.0'
}

repositories {
mavenCentral()
}

dependencies {
testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
}

test {
useJUnitPlatform()

testLogging {
events "passed", "skipped", "failed"

showExceptions true
exceptionFormat "full"
showCauses true
showStackTraces true
showStandardStreams = false
}
}

application {
mainClassName = "seedu.duke.Duke"
}

shadowJar {
archiveBaseName = "duke"
archiveClassifier = null
}

checkstyle {
toolVersion = '8.29'
}

run{
standardInput = System.in
}
131 changes: 116 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,130 @@
# User Guide
Add Task
Adds a task to the current list for KaiKai to handle.

## Features
Delete Task
Delete a task from the current list.

### Feature-ABC
List Tasks
Lists all tasks.

Description of the feature.
Mark Task
Mark a task as done.

### Feature-XYZ
Unmark Task
Mark a task as undone.

Description of the feature.
Find Task
Find all tasks matching the search term.

## Usage
Exit
Closes the app.

### `Keyword` - Describe action
Usage
add - Adding a task
Add a task to the task list

Describe the action and its outcome.
Example of usage:

Example of usage:
Adding Tasks
Adds a task to Duke to manage

`keyword (optional arguments)`
To-do item

Format: todo DESCRIPTION

Adds a todo with a DESCRIPTION
Event item

Format: event DESCRIPTION /at DATE

Adds an event with a DESCRIPTION and a DATE representing when the event is happening
Deadline item

Format: deadline DESCRIPTION /by DATETIME

Adds a deadline task with a DESCRIPTION and a deadline DATETIME
DATETIME must be in the format yyyy-MM-dd HHmm
e.g. deadline assignment /by 2022-02-14 1800
delete - Deleting a task
Delete a task from the task list

Add task to Duke

Example of usage:

deadline return book /by 2022-12-02 1800

Expected outcome:

Description of the outcome.
____________________________________________________________
Got it. I've added this task:
[D][ ] return book (by: 02 Dec 2022 06:00 PM)
Now you have 1 tasks in the list
____________________________________________________________

Example of usage:

delete

Expected outcome:

Deleting tasks
Remove task from Duke

Example of usage:

delete 1

Expected outcome:

____________________________________________________________
Noted. I've removed this task:
[D][ ] return book (by: 12 Feb 2022 06:00 PM)
Now you have 0 tasks in the list
____________________________________________________________

list - Listing all tasks
Delete a task from the task list

Example of usage:

list

Expected outcome (example list):

1. [T][X] read book
2. [E][ ] mug (start: 01/01/2001 01:01, end: 01/01/2001 01:01)
3. [D][ ] mug more (by: 01/01/2001 01:01)
4. [E][ ] submit ip (start: 11/12/1234 11:11, end: 11/02/1234 00:00)
mark - Mark a task
Mark a task as done.

Example of usage:

mark

Expected outcome (example list):

____________________________________________________________
Here are the tasks in your list:
1. [T][ ] borrow book
2. [D][ ] return book (by: 02 Dec 2022 06:00 PM)
3. [E][ ] project meeting (at: Monday 2-4pm)
_________________________________________________
Which task would you like to mark as completed?
Shows the current list of tasks and prompts for which task to mark (by index).

unmark - Unmark a task
Mark a task as undone.


bye - Exit
Closes and app

Example of usage:

bye

Expected outcome:

```
expected output
```
Bye! Hope to see you again!
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
5 changes: 5 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.2-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
183 changes: 183 additions & 0 deletions gradlew

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading