From 3c784794d6197a1852b2a9cdb27f006579a85b2d Mon Sep 17 00:00:00 2001 From: Nereus Ng Wei Bin Date: Tue, 19 Sep 2023 01:49:07 +0800 Subject: [PATCH] Add user guide in README --- docs/README.md | 77 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 61 insertions(+), 16 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8077118ebe..bc3ba02f63 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,29 +1,74 @@ -# User Guide +# Corgi - The Most Intelligent Chatbot -## Features +Corgi is a simple yet powerful task management chatbot designed to help you keep track of your tasks, deadlines, and events. Whether you're a busy professional, a student, or just someone looking to stay organized, Corgi has got you covered. -### Feature-ABC +## Getting Started -Description of the feature. +To get started with Corgi, follow these simple steps: -### Feature-XYZ +1. **Download the JAR File** + - Visit the "Releases" section of this [GitHub repository](https://github.com/NereusWB922/ip/releases). + - Download the latest `corgi.jar` file to your computer. -Description of the feature. +2. **Installation** + - Ensure that you have Java 11 (or above) installed on your system. You can download Java 11 from [Oracle's official website](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html) or use an OpenJDK distribution. -## Usage +3. **Run Corgi** + - Navigate to the directory where you downloaded `corgi.jar`. + - Run the following command to launch Corgi: + ``` + java -jar corgi.jar + ``` -### `Keyword` - Describe action +4. **Usage** + - Start entering commands to add, manage, and track your tasks and events. + - Refer to the the next section for a list of available commands and their formats. -Describe the action and its outcome. +## Features -Example of usage: +Corgi supports a variety of commands to manage your tasks effectively: -`keyword (optional arguments)` +1. **TODO** + - Command: `todo /desc [task]` + - Description: Add a new todo to your list. -Expected outcome: +2. **DEADLINE** + - Command: `deadline /desc [task] /by [yyyy-mm-dd]` + - Description: Add a task with a specific deadline. -Description of the outcome. +3. **EVENT** + - Command: `event /desc [task] /from [yyyy-mm-dd] /to [yyyy-mm-dd]` + - Description: Add an event with a start and end date. + +4. **MARK** + - Command: `mark /target [task no.]` + - Description: Mark a task as completed. + +5. **UNMARK** + - Command: `unmark /target [task no.]` + - Description: Unmark a completed task. + +6. **DELETE** + - Command: `delete /target [task no.]` + - Description: Delete a task or event. + +7. **DATE** + - Command: `date /target [yyyy-mm-dd]` + - Description: Filter tasks and events by a specific date. + +8. **FIND** + - Command: `find /target [keyword]` + - Description: Search for tasks or events containing a keyword. + +9. **LIST** + - Command: `list` + - Description: View your list of tasks and events. + +10. **UNDO** + - Command: `undo` + - Description: Undo the previous action. + +11. **BYE** + - Command: `bye` + - Description: Exit the Corgi app. -``` -expected output -```