From a557c36a43c50126aed3457e3f4e2b92979ea706 Mon Sep 17 00:00:00 2001 From: limsiying <42372947+limsiying@users.noreply.github.com> Date: Thu, 26 Sep 2019 23:28:06 +0800 Subject: [PATCH] update user guide and readme (#34) * test * test * test * test * test * test * test * image * image * image * image * update * update * update * update * update --- README.adoc | 16 +++ README.md | 154 ----------------------------- docs/AboutUs.adoc | 4 - docs/ContactUs.adoc | 6 ++ docs/README.md | 154 ----------------------------- docs/UserGuide.adoc | 230 ++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 252 insertions(+), 312 deletions(-) create mode 100644 README.adoc delete mode 100644 README.md create mode 100644 docs/ContactUs.adoc delete mode 100644 docs/README.md create mode 100644 docs/UserGuide.adoc diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000000..1cfa5d5f58 --- /dev/null +++ b/README.adoc @@ -0,0 +1,16 @@ += Duchess +![alt text](https://github.com/AY1920S1-CS2113T-T09-2/main/blob/master/docs/images/Ui.PNG) + +* Duchess is a calendar application tailor-made for NUS students. +* It provides an interface for students to manage both their school and extra-curriculum commitments while providing academic contextual information. +* User interactions happen using a Command Line Interface. + +== Site Map +* https://github.com/AY1920S1-CS2113T-T09-2/main/blob/master/docs/UserGuide.adoc[User Guide^] +* https://github.com/AY1920S1-CS2113T-T09-2/main/blob/master/docs/AboutUs.adoc[Developer Guide^] +* https://github.com/AY1920S1-CS2113T-T09-2/main/blob/master/docs/AboutUs.adoc[About Us^] +* https://github.com/AY1920S1-CS2113T-T09-2/main/blob/master/docs/ContactUs.adoc[Contact Us^] + +== Acknowledgements +* This application is a morph of the CS2113 Duke application. +* Libraries used: \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index a1ffd8425e..0000000000 --- a/README.md +++ /dev/null @@ -1,154 +0,0 @@ -# User Guide -![alt text](https://github.com/AY1920S1-CS2113T-T09-2/main/blob/master/docs/images/Ui.PNG) - -Duchess is a calendar application tailor-made for NUS students. It provides an interface for students to manage both their school timetable and commitments schedule while providing useful contextual information and features. - -## Features - -### Add different task types to todo list -Students can manage their own todo list and add tasks to it. They can tag the tasks with three different types: todo, event or deadline. The status of every tasks will be tracked as done or undone. New tasks will be set to an undone status, which can be changed to done. - -### Organise and retrieve task list -Students will be able to: -* view the task list -* view the schedule for a paticular date -* search if a task exists -* delete tasks -* mark a task as done -* get reminders for tasks with deadlines - -## Usage - -### `todo ` - Add a todo task - -Adds a todo task to the task list. The todo task is initially marked as undone. - -Example of usage: - -`todo go buy running shoes` - -Expected outcome: - -``` -Got it. I've added this task: - [T][✘] go buy running shoes -Now you have 1 task in the list. -``` - -### `event /at to ` - Add an event - -Adds an event to the task list. The event is initially marked as undone. - -Example of usage: - -`event student life fair /at 10/9/2019 1400 to 10/9/2019 1750` - -Expected outcome: - -``` -Got it. I've added this task: - [E][✘] student life fair (at: 10/09/2019 1400 to 10/09/2019 1750) -Now you have 1 task in your list. -``` - -### `deadline /by ` - Add a deadline - -Adds a deadline to the task list. The deadline is initially marked as undone. - -Example of usage: - -`deadline geh1049 essay /by 20/9/2019 1800` - -Expected outcome: - -``` -Got it. I've added this task: - [D][✘] geh1049 essay (by: 20/9/2019 1800) -Now you have 1 task in your list. -``` - -### `list` - Displays task list - -Displays task list in numbered bullet point format. - -Example of usage: - -`list` - -Expected outcome: - -``` -Here are the tasks in your list: -1. [T][✘] go buy running shoes -2. [E][✘] student life fair (at: 10/09/2019 1400 to 10/09/2019 1750) -3. [D][✘] geh1049 essay (by: 20/9/2019 1800) -``` - -### `done ` - Mark task as done - -Marks a task in the task list as done. - -Example of usage: - -`done 1` - -Expected outcome: - -``` -Nice! I've marked this task as done: - [T][✓] go buy running shoes -``` - -### `delete ` - Remove task from task list - -Removes task from task list. - -Example of usage: - -`delete 1` - -Expected outcome: - -``` -Noted. I've removed this task: - [T][✓] go buy running shoes -Now you have 2 tasks in the list. -``` - -### `schedule ` - Display schedule for a paticular date - -Displays the schedule for a specific day. Time and task details are printed in a timetable. Ongoing events beginning before or lasting past the date are indicated below the timetable. - -Example of usage: - -`schedule 17/9/2019` - -Expected outcome: - -``` -Here is your schedule: ------------------------------------------------------ -| 17/9/2019 | ------------------------------------------------------ -| Time | Task | ------------------------------------------------------ -| 1400 | [E][Γ✘] student life fair | ------------------------------------------------------ -Here are your ongoing tasks: -1. [E][✘] health and wellness forum (at: 14/09/2019 1500 to 18/09/2019 1200) -``` - -### `reminder` - Display all tasks with deadlines - -Display all tasks with deadlines. - -Example of usage: - -`reminder` - -Expected outcome: - -``` -You currently have these deadlines. -1. [D][✘] health and wellness transcript (by: 19/09/2019 0800) -``` \ No newline at end of file diff --git a/docs/AboutUs.adoc b/docs/AboutUs.adoc index cbc6cbf6fc..6f657f1437 100644 --- a/docs/AboutUs.adoc +++ b/docs/AboutUs.adoc @@ -1,10 +1,6 @@ = About Us :imagesDir: images -//// :site-section: AboutUs -:relfileprefix: team/ -:stylesDir: stylesheets -//// Duchess was developed by the T09-2 Team. + We are a Chess team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore]. diff --git a/docs/ContactUs.adoc b/docs/ContactUs.adoc new file mode 100644 index 0000000000..a6b70a45d6 --- /dev/null +++ b/docs/ContactUs.adoc @@ -0,0 +1,6 @@ += Contact Us +:site-section: ContactUs +:stylesDir: stylesheets + +* *Bug reports, Suggestions* : Post in our https://github.com/AY1920S1-CS2113T-T09-2/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve. +* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here] \ No newline at end of file diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index a1ffd8425e..0000000000 --- a/docs/README.md +++ /dev/null @@ -1,154 +0,0 @@ -# User Guide -![alt text](https://github.com/AY1920S1-CS2113T-T09-2/main/blob/master/docs/images/Ui.PNG) - -Duchess is a calendar application tailor-made for NUS students. It provides an interface for students to manage both their school timetable and commitments schedule while providing useful contextual information and features. - -## Features - -### Add different task types to todo list -Students can manage their own todo list and add tasks to it. They can tag the tasks with three different types: todo, event or deadline. The status of every tasks will be tracked as done or undone. New tasks will be set to an undone status, which can be changed to done. - -### Organise and retrieve task list -Students will be able to: -* view the task list -* view the schedule for a paticular date -* search if a task exists -* delete tasks -* mark a task as done -* get reminders for tasks with deadlines - -## Usage - -### `todo ` - Add a todo task - -Adds a todo task to the task list. The todo task is initially marked as undone. - -Example of usage: - -`todo go buy running shoes` - -Expected outcome: - -``` -Got it. I've added this task: - [T][✘] go buy running shoes -Now you have 1 task in the list. -``` - -### `event /at to ` - Add an event - -Adds an event to the task list. The event is initially marked as undone. - -Example of usage: - -`event student life fair /at 10/9/2019 1400 to 10/9/2019 1750` - -Expected outcome: - -``` -Got it. I've added this task: - [E][✘] student life fair (at: 10/09/2019 1400 to 10/09/2019 1750) -Now you have 1 task in your list. -``` - -### `deadline /by ` - Add a deadline - -Adds a deadline to the task list. The deadline is initially marked as undone. - -Example of usage: - -`deadline geh1049 essay /by 20/9/2019 1800` - -Expected outcome: - -``` -Got it. I've added this task: - [D][✘] geh1049 essay (by: 20/9/2019 1800) -Now you have 1 task in your list. -``` - -### `list` - Displays task list - -Displays task list in numbered bullet point format. - -Example of usage: - -`list` - -Expected outcome: - -``` -Here are the tasks in your list: -1. [T][✘] go buy running shoes -2. [E][✘] student life fair (at: 10/09/2019 1400 to 10/09/2019 1750) -3. [D][✘] geh1049 essay (by: 20/9/2019 1800) -``` - -### `done ` - Mark task as done - -Marks a task in the task list as done. - -Example of usage: - -`done 1` - -Expected outcome: - -``` -Nice! I've marked this task as done: - [T][✓] go buy running shoes -``` - -### `delete ` - Remove task from task list - -Removes task from task list. - -Example of usage: - -`delete 1` - -Expected outcome: - -``` -Noted. I've removed this task: - [T][✓] go buy running shoes -Now you have 2 tasks in the list. -``` - -### `schedule ` - Display schedule for a paticular date - -Displays the schedule for a specific day. Time and task details are printed in a timetable. Ongoing events beginning before or lasting past the date are indicated below the timetable. - -Example of usage: - -`schedule 17/9/2019` - -Expected outcome: - -``` -Here is your schedule: ------------------------------------------------------ -| 17/9/2019 | ------------------------------------------------------ -| Time | Task | ------------------------------------------------------ -| 1400 | [E][Γ✘] student life fair | ------------------------------------------------------ -Here are your ongoing tasks: -1. [E][✘] health and wellness forum (at: 14/09/2019 1500 to 18/09/2019 1200) -``` - -### `reminder` - Display all tasks with deadlines - -Display all tasks with deadlines. - -Example of usage: - -`reminder` - -Expected outcome: - -``` -You currently have these deadlines. -1. [D][✘] health and wellness transcript (by: 19/09/2019 0800) -``` \ No newline at end of file diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc new file mode 100644 index 0000000000..ef8c428883 --- /dev/null +++ b/docs/UserGuide.adoc @@ -0,0 +1,230 @@ += Duchess - User Guide +:site-section: UserGuide +:toc: +:toc-title: +:toc-placement: preamble +:sectnums: +:imagesDir: images +:xrefstyle: full +:experimental: +ifdef::env-github[] +:tip-caption: :bulb: +:note-caption: :information_source: +endif::[] +:repoURL: https://github.com/AY1920S1-CS2113T-T09-2/main + +By: `CS2113T-T09-2` + +== Introduction + +Duchess is a Command Line Interface (CLI) calendar. It provides an interface for students to manage both their school timetable and commitments schedule while providing useful contextual information and features. + +== Quick Start + +image::Ui.png[] + +. Ensure you have Java `11` or above installed in your Computer. +. Download the latest `duchess.jar` link:{repoURL}/releases[here]. +. Copy the file to the folder you want to use as the home folder for your Calander. +. Double-click the file to start the app. + +[[Features]] +== Features + +=== Adding todo task: `todo ` + +Adds a todo task to the task list. The todo task is initially marked as undone. + +Example of usage: + +`todo go buy running shoes` + +Expected outcome: + +``` +Got it. I've added this task: + [T][✘] go buy running shoes +Now you have 1 task in the list. +``` + +=== Adding an event task: `event /at to ` + +Adds an event to the task list. The event is initially marked as undone. + +Example of usage: + +`event student life fair /at 10/9/2019 1400 to 10/9/2019 1750` + +Expected outcome: + +``` +Got it. I've added this task: + [E][✘] student life fair (at: 10/09/2019 1400 to 10/09/2019 1750) +Now you have 1 task in your list. +``` + +=== Adding a deadline task: `deadline /by ` + +Adds a deadline to the task list. The deadline is initially marked as undone. + +Example of usage: + +`deadline geh1049 essay /by 20/9/2019 1800` + +Expected outcome: + +``` +Got it. I've added this task: + [D][✘] geh1049 essay (by: 20/9/2019 1800) +Now you have 1 task in your list. +``` + +=== Display task list: `list` + +Displays task list in numbered bullet point format. + +Example of usage: + +`list` + +Expected outcome: + +``` +Here are the tasks in your list: +1. [T][✘] go buy running shoes +2. [E][✘] student life fair (at: 10/09/2019 1400 to 10/09/2019 1750) +3. [D][✘] geh1049 essay (by: 20/9/2019 1800) +``` + +=== Mark task as done: `done ` + +Marks a task in the task list as done. + +Example of usage: + +`done 1` + +Expected outcome: + +``` +Nice! I've marked this task as done: + [T][✓] go buy running shoes +``` + +=== Remove task from task list: `delete ` + +Removes task from task list. + +Example of usage: + +`delete 1` + +Expected outcome: + +``` +Noted. I've removed this task: + [T][✓] go buy running shoes +Now you have 2 tasks in the list. +``` + +=== Find tasks containing keyword: `find ` + +Displays list of tasks containing keyword. + +Example of usage: + +`find geh1049` + +Expected outcome: + +``` +Here are the matching tasks in your list: +1. [T][✓] geh1049 readings +2. [D][✘] geh1049 essay (by: 20/9/2019 1800) +``` + +=== Display schedule for a paticular date: `schedule ` + +Displays the schedule for a specific day. Time and task details are printed in a timetable. Ongoing events beginning before or lasting past the date are indicated below the timetable. + +Example of usage: + +`schedule 17/9/2019` + +Expected outcome: + +``` +Here is your schedule: +----------------------------------------------------- +| 17/9/2019 | +----------------------------------------------------- +| Time | Task | +----------------------------------------------------- +| 1400 | [E][Γ✘] student life fair | +----------------------------------------------------- +Here are your ongoing tasks: +1. [E][✘] health and wellness forum (at: 14/09/2019 1500 to 18/09/2019 1200) +``` + +=== Display tasks with deadlines: `reminder` + +Display all tasks with deadlines. + +Example of usage: + +`reminder` + +Expected outcome: + +``` +You currently have these deadlines. +1. [D][✘] health and wellness transcript (by: 19/09/2019 0800) +``` + +=== Push back time bound tasks: `snooze ` + +Adds a week to time bound task. Deadline and event timings are pushed back by a week. + +Example of usage: + +`snooze 1` + +Expected outcome: + +``` +Noted. I've snoozed this task: + [D][✘] health and wellness transcript (by: 26/09/2019 0800) +``` + +=== Exiting the program: `bye` + +Exits the program. + +Example of usage: + +`bye` + +Expected outcome: + +``` +Bye. Hope to see you again soon! +``` + +== FAQ + +*Q*: Am I able to export my schedule from command line? + +*A*: All schedules are saved in a text file which can be accessed outside of CLI. + +== Command Summary + +. Add todo: `todo ` +. Add event: `event /at to ` +. Add deadline: `deadline /by ` +. Display tasks: `list` +. Mark as done: `done ` +. Remove task: `delete ` +. Find task: `find ` +. Display schedule: `schedule ` +. Display deadlines: `reminder` +. Snooze task: `snooze ` +. Exit: `bye` \ No newline at end of file