Skip to content

Commit

Permalink
Update UserGuide Website
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronxujiachen committed Oct 5, 2023
1 parent 76e80b4 commit a1189ae
Showing 1 changed file with 46 additions and 16 deletions.
62 changes: 46 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,59 @@
# User Guide
# Dude Chatbot User Guide

## Features
Welcome to Dude, your trusty task management chatbot. Dude helps you stay organized by keeping track of your tasks, whether they're to-dos, deadlines, or events. This user guide will provide you with the essential information to make the most of Dude's features.

### Feature-ABC

Description of the feature.
## Getting Started

### Feature-XYZ
To get started with Dude, follow these steps:

Description of the feature.
1. Ensure you have Java Development Kit (JDK) 11 installed on your computer.
2. Make sure you have the latest version of IntelliJ IDEA installed.
3. Clone or download the Dude project repository.

## Usage
## Setting Up Dude in IntelliJ IDEA

### `Keyword` - Describe action
1. Open IntelliJ IDEA.
2. If you have an existing project open, close it.
3. Click on "File" > "Open" and select the Dude project directory.
4. Configure the project to use JDK 11:
- Click on "File" > "Project Structure."
- Under "Project," set the "Project SDK" to JDK 11.
- Set the "Project language level" to "SDK default."

Describe the action and its outcome.
## Running Dude

Example of usage:
1. Locate the `Dude.java` file in the `src/main/java` directory of the Dude project.
2. Right-click on `Dude.java` and select "Run Dude.main()".
3. If everything is set up correctly, Dude will start, and you'll see a greeting message.

`keyword (optional arguments)`
## Using Dude

Expected outcome:
Dude understands various commands to manage your tasks. Here are some essential commands:

Description of the outcome.
- `list`: List all tasks in your task list.
- `todo <description>`: Add a to-do task.
- `deadline <description> /by <due_date>`: Add a deadline task.
- `event <description> /from <start_date> /to <end_date>`: Add an event task.
- `mark <task_index>`: Mark a task as done.
- `unmark <task_index>`: Mark a task as not done.
- `delete <task_index>`: Delete a task from the list.
- `find <keyword>`: Find tasks containing a specific keyword.
- `bye`: Exit Dude.

```
expected output
```
## Examples:

- To add a to-do task: `todo Buy groceries`
- To add a deadline task: `deadline Submit report /by 2023-12-31`
- To add an event task: `event Team meeting /from 2023-09-30 /to 2023-10-01`
- To mark a task as done: `mark 1`
- To delete a task: `delete 2`
- To find tasks containing a keyword: `find book`

Remember to replace `<description>`, `<due_date>`, `<start_date>`, `<end_date>`, `<task_index>`, and `<keyword>` with your specific task details.

## Conclusion

You're now ready to start using Dude to manage your tasks efficiently. If you have any questions or encounter issues, feel free to reach out to us. Dude is here to make task management a breeze!

Happy tasking!

0 comments on commit a1189ae

Please sign in to comment.