Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
colinhia committed Sep 20, 2024
1 parent f1d3c83 commit 36a49fe
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 14 deletions.
4 changes: 4 additions & 0 deletions data/julie.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ T | nothing
T | 1
T | 2
T | 1
T | Task1
T | Task 2
E | Event1 | 2002-02-02 | 2002-03-02
D | Deadline1 | 2002-02-02
66 changes: 52 additions & 14 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,68 @@
# Duke User Guide
# Julie User Guide

// Update the title above to match the actual product name
![A screenshot of the Julie Chatbot in use.](../docs/Ui.png)

// Product screenshot goes here
_Hi! I'm Julie! A personal Chatbot who can
help you keep track of your tasks!_

// Product intro goes here
## Adding Tasks
Julie supports 3 types of tasks:

## Adding deadlines
### Todos: Tasks with no time constraints.

// Describe the action and its outcome.
Example: `todo taskName`

// Give examples of usage
```
Nice! I've added it to the list!
T[ ] taskName
```

### Deadlines: Tasks with a deadline.

Example: `deadline taskName /by yyyy-mm-dd`

Example: `keyword (optional arguments)`
```
Nice! I've added it to the list!
D[ ] taskName (by: mmm dd yy)
```

// A description of the expected outcome goes here
### Events: Tasks with a start and end time.

Example: `event taskName /from yyyy-mm-dd
/to yyyy-mm-dd`

```
expected output
Nice! I've added it to the list!
D[ ] taskName (from: mmm dd yy to: mmm dd yy)
```

## Feature ABC
## Marking Tasks:
A task can either be marked as completed, or incomplete.

### Marking Completion:
Example: `mark taskNumber`

```
Ooh, this task is done!
T[X] taskName //the task that corresponds with the number
```

### Un-marking Completion:
Example: `unmark taskNumber`

```
Oop, this task is not yet done
T[ ] taskName //the task that corresponds with the number
```

// Feature details
## List
`list` will return the list of tasks currently recorded by Julie

## Delete
`delete taskNumber` will delete the corresponding task

## Feature XYZ
## Tag
`tag taskNumber tagString` will add a Tag with the tagString to the corresponding task.

// Feature details
## Find
`find searchString` will return a list of all tasks with the string in the name.
Binary file added docs/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 36a49fe

Please sign in to comment.