diff --git a/README.md b/README.md index 90aa7f092..831573b25 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Duke project template +# Quinn project template This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it. @@ -13,12 +13,15 @@ Prerequisites: JDK 17, update Intellij to the most recent version. 1. If there are any further prompts, accept the defaults. 1. Configure the project to use **JDK 17** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).
In the same dialog, set the **Project language level** field to the `SDK default` option. -3. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output: +3. After that, locate the `src/main/java/quinn/Quinn.java` file, right-click it, and choose `Run Quinn.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output: ``` Hello from - ____ _ - | _ \ _ _| | _____ - | | | | | | | |/ / _ \ - | |_| | |_| | < __/ - |____/ \__,_|_|\_\___| + + QQQ U U III N N N N + Q Q U U I NN N NN N + Q Q U U I N N N N N N + Q Q U U I N NN N NN + QQQ UUU III N N N N + Q + QQ ``` diff --git a/docs/README.md b/docs/README.md index 47b9f984f..8ab79f9df 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,30 +1,157 @@ -# Duke User Guide +# Quinn Task Manager User Guide -// Update the title above to match the actual product name +Quinn is a personal assistant chatbot that helps in Task Management.
+It is a desktop application optimized to use from a Command Line Interface (CLI).
+Quinn helps to keep track of your to-dos, deadlines, and events.
+With Quinn, you can easily add, list, mark, and delete tasks using simple commands.
+This User Guide(UG) is also found at this link : [Quinn User Guide](https://kaboomzxc.github.io/ip/) -// Product screenshot goes here +## Table of Contents +1. [Quick Start](#quick-start) +2. [Features](#features) +3. [Command Reference](#command-reference) +4. [Understanding Task Types](#understanding-task-types) +5. [Error Handling](#error-handling) +6. [Data Storage](#data-storage) +7. [Quinn Command Summary](#quinn-command-summary) -// Product intro goes here +## Quick Start -## Adding deadlines +1. Ensure you have Java 17 installed on your computer. +2. Download the latest `Quinn.jar` file from [here](https://github.com/kaboomzxc/ip/releases). +3. Copy the file to your desired folder. +4. Open a command prompt or terminal, navigate to the folder containing Quinn.jar, and run: **java -jar Quinn.jar** -// Describe the action and its outcome. -// Give examples of usage +## Features -Example: `keyword (optional arguments)` +### Adding Tasks -// A description of the expected outcome goes here +Quinn supports three types of tasks: ToDos, Deadlines, and Events. -``` -expected output -``` +#### Adding a ToDo +Command: `todo `
+Example: `todo Buy groceries` + +#### Adding a Deadline +Command: `deadline /by