Merge pull request nus-cs2113-AY2223S2#41 from hrithie/hrithieMenon-v1.0

Update User Guide.md, ReadMe.md, Expected.txt and Ui.java

docs/README.md

@@ -1,6 +1,10 @@
-# Duke
+# NUSPlanner
 
-{Give product intro here}.
+🗓️ NUSPlanner is a desktop app that allows for an *easy* and *straightforward* way for NUS students to manage their schedule ranging from person, school or external related activities. This application makes use of a desktop Command Line Interface (CLI), enabling a quick and sleek method of getting your schedule in check.
+
+⌨️ If you can type fast, NUSPlanner can get your contact management tasks done faster and more efficiently than traditional GUI apps.
+
+✅ NUSPlanner is available for download for operating systems such as Windows, Linux and OS-X.
 
 Useful links:
 * [User Guide](UserGuide.md)

docs/UserGuide.md

@@ -1,42 +1,127 @@
 # User Guide
 
-## Introduction
+## Table of Contents
+- [Introduction](#7-introduction)
+- [Quick Start](#14-quick-start)
+- [Features](#25-features)
+- [FAQ](#100-faq)
+- [Command Summary](#113-command-summary)
 
-{Give a product intro}
+## 1.0 Introduction
+🗓️ NUSPlanner is a desktop app that allows for an *easy* and *straightforward* way for NUS students to manage their schedule ranging from person, school or external related activities. This application makes use of a desktop Command Line Interface (CLI), enabling a quick and sleek method of getting your schedule in check.
 
-## Quick Start
+⌨️ If you can type fast, NUSPlanner can get your contact management tasks done faster and more efficiently than traditional GUI apps.
 
-{Give steps to get started quickly}
+✅ NUSPlanner is available for download for operating systems such as Windows, Linux and OS-X.
 
-1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+## 2.0 Quick Start
+Before we get started, here's what you need to do:
 
-## Features 
+1. Ensure that you have Java 11 or above installed.
+2. Down the latest version of `NUSPlanner.jar` from [here](http://link.to/NUSPlanner.jar).
+3. Open your terminal or command prompt
+4. Navigate to the file directory of where the jar file is saved
+5. Execute `NUSPlanner.jar` using the following command: `java -jar NUSPlanner.jar` 
+6. Refer to section [3.0 Features] for more details of commands
+
+## 3.0 Features 
+
+Read this section to find out how NUSPlanner can make your life easier!
+
+### Adding an event: `add`
+Adds an event to the schedule. Assuming x is an switch. Use –x to specify the attributes to edit. 
+
+Format: `add –e EVENTNAME –st STARTTIME –sd STARTDATE –et ENDTIME –ed ENDDATE`
+* sd and ed must be of the format YYYY/MM/DD
+* ed is an optional field, where the default value is sd when not specified
+
+#### Examples of usage
+* Add event that starts and ends on different days: `add –e Career Fair –st 14:00 –sd 2023/02/10 –et 16:00 –ed 2023-02-11`
+* Add event that starts and ends on same day: `add –e Career Fair –st 14:00 –sd 2023/02/10 –et 16:00`
+
+Expected outcome:
+~~~
+____________________________________________________________
+Event successfully added!
+____________________________________________________________
+~~~
+
+### Deleting an event: `delete`
+Delete a single event or all events from the schedule. Use –s to specify the events to delete, or –all to delete all events.
+
+Format:
+* `delete –s INDEX_OF_EVENT `
+* `delete -all`
+
+#### Examples of usage
+* Delete a single event: `delete –s 1`
+* Delete all events: `delete -all`
+
+Expected outcome:
+~~~
+____________________________________________________________
+Event(s) successfully deleted!
+____________________________________________________________
+~~~
+
+### List an event: `list`
+Displays a list of all events that have been added to the schedule.
+
+Format: `list`
+
+#### Examples of usage
+* List all events: `list`
+
+Expected outcome:
+~~~
+____________________________________________________________
+Here are your event(s):
+1. CS2100 Tutorial on 18/03/2023 from 3pm to 5pm
+2. Penetration Testing Bootcamp on 19/03/2023 to 23/03/2023 from 12pm to 6pm
+____________________________________________________________
+~~~
+
+### Editing an event: `edit`
+Edit an event that has been added to the schedule. Use –x to specify the attributes to edit.
+
+Format:
+* `edit -i INDEX_OF_EVENT –st STARTTIME –sd STARTDATE –et ENDTIME –ed ENDDATE`
+
+#### Examples of usage
+* Edit the start time of an event: `edit –i 2 –st 16:00`
+* Edit the start date, start time and end time of an event: `edit -i 3 –sd 2023/02/11 –st 8:00 –et 10:00 `
+
+Expected outcome:
+~~~
+____________________________________________________________
+Event edited successfully!
+____________________________________________________________
+~~~
 
-{Give detailed description of each feature}
+## FAQ
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+**Q**: Why is a JAR file required?
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+**A**: Java ARchive, also known as JAR, is a container that groups multiple small files to enable efficient execution, which is similar to a ZIP file. 
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
 
-Example of usage: 
+**Q**: Where can I report bugs I found while using NUSPlanner?
 
-`todo n/Write the rest of the User Guide d/next week`
+**A**: Our team of developers are always on the look-out to fix such bugs.
+Please add a description of the bug found under our [Issue Tracker]([here](https://github.com/AY2223S2-CS2113-F13-3/tp/issues)).
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+## Command Summary
+👉 Words in **CAPITAL LETTERS** are user input
 
-## FAQ
+👉 Each word is separated by only a **single whitespace**
 
-**Q**: How do I transfer my data to another computer? 
 
-**A**: {your answer here}
+**Command | Description**
+* `add –e EVENTNAME –st STARTTIME –sd STARTDATE –et ENDTIME –ed ENDDATE` | Add event
+* `delete –s 1` | Delete a single event
+* `delete -all` | Delete all events
+* `list` | List all events
+* `edit -i INDEX_OF_EVENT –st STARTTIME –sd STARTDATE –et ENDTIME –ed ENDDATE` | Edit event
 
-## Command Summary
 
-{Give a 'cheat sheet' of commands here}
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`

src/main/java/seedu/duke/Ui.java

@@ -36,12 +36,9 @@ public static void getUserCommand(EventList eventList) {
      * users when application is launched
      */
     public static void showWelcome() {
-        String logo = " ____        _        \n"
-                + "|  _ \\ _   _| | _____ \n"
-                + "| | | | | | | |/ / _ \\\n"
-                + "| |_| | |_| |   <  __/\n"
-                + "|____/ \\__,_|_|\\_\\___|\n";
-        System.out.println("Hello from\n" + logo);
+        String logo =  "█▄ █ █ █ ▄▀▀ █▀▄ █   ▄▀▄ █▄ █ █▄ █ ██▀ █▀▄\n"
+                + "█ ▀█ ▀▄█ ▄██ █▀  █▄▄ █▀█ █ ▀█ █ ▀█ █▄▄ █▀▄\n\n";
+        System.out.println(logo + "Hello there! What can we do for you today?");
         printDash();
     }
 
@@ -55,6 +52,16 @@ public static void addSuccessMsg() {
         printDash();
     }
 
+    /**
+     * Prints success message for
+     * users when event is edited
+     */
+    public static void addSuccessEditMsg() {
+        printDash();
+        System.out.println("Event successfully edited!");
+        printDash();
+    }
+
     /**
      * Prints error message for
      * users when there is unrecognised
@@ -72,7 +79,7 @@ public static void addErrorMsg() {
      */
     public static void deleteSuccessMsg() {
         printDash();
-        System.out.println("Event successfully deleted!");
+        System.out.println("Event(s) successfully deleted!");
         printDash();
     }
 

text-ui-test/EXPECTED.TXT

@@ -1,8 +1,5 @@
-Hello from
- ____        _        
-|  _ \ _   _| | _____ 
-| | | | | | | |/ / _ \
-| |_| | |_| |   <  __/
-|____/ \__,_|_|\_\___|
+█▄ █ █ █ ▄▀▀ █▀▄ █   ▄▀▄ █▄ █ █▄ █ ██▀ █▀▄
+█ ▀█ ▀▄█ ▄██ █▀  █▄▄ █▀█ █ ▀█ █ ▀█ █▄▄ █▀▄
 
+Hello there! What can we do for you today?
 ____________________________________________________________