Skip to content

Commit

Permalink
Merge pull request nusCS2113-AY1819S1#88 from leegengyu/master
Browse files Browse the repository at this point in the history
Made changes to UG/DG/PPP
  • Loading branch information
leegengyu authored Nov 1, 2018
2 parents febe88e + 79d7613 commit e17e5c4
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 35 deletions.
4 changes: 2 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= N*Sync
= NSync
ifdef::env-github,env-browser[:relfileprefix: docs/]

https://travis-ci.org/CS2113-AY1819S1-W12-2/main[image:https://travis-ci.org/CS2113-AY1819S1-W12-2/main.svg?branch=master[Build Status]]
Expand All @@ -12,7 +12,7 @@ ifndef::env-github[]
image::images/Ui.png[width="600"]
endif::[]

* N*Sync is a utility application targeted at NUS students, to simplify some of their daily routines such as arranging a common timeslot with friends, and downloading their notes from IVLE.
* NSync is a utility application targeted at NUS students, to simplify some of their daily routines such as arranging a common timeslot with friends, and downloading their notes from IVLE.
* As a Java application, it has a Graphical User Interface (GUI) but most of the user interactions happen through a Command Line Interface (CLI).
== Site Map
Expand Down
2 changes: 1 addition & 1 deletion docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= NUSync - Developer Guide
= NSync - Developer Guide
:site-section: DeveloperGuide
:toc:
:toc-title:
Expand Down
16 changes: 10 additions & 6 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= N*Sync - User Guide
= NSync - User Guide
:site-section: UserGuide
:toc:
:toc-title:
Expand All @@ -19,7 +19,7 @@ By: `CS2113-AY1819S1-W12-2` Since: `Aug 2018` Licence: `MIT`

== Introduction

N*Sync is a program for NUS students who *strive to keep their lives organised, despite their busy schedules*.
NSync is a program for NUS students who *strive to keep their lives organised, despite their busy schedules*.
Interested? Jump to the <<Quick Start>> to get started. Enjoy!

== Quick Start
Expand Down Expand Up @@ -387,11 +387,15 @@ Shows the next available time slot (from current time) for contacts whose indice

==== Export user string: `export`

To be filled in.
Format: `export INDEX`
****
* Exports all of a user's details in each respective field into a non-readable string.
*
****

==== Import user string: `import`

To be filled in.
Format: `import <string>`

=== Notes Commands

Expand Down Expand Up @@ -424,7 +428,7 @@ of the specified module.
image::chromeOpen.PNG[width="250"]
* N*Sync might be unresponsive during the download, it is so to prevent you from accidentally introducing file corruption.
* NSync might be unresponsive during the download, it is so to prevent you from accidentally introducing file corruption.
* If the process is successful, the result window of NSync will display the exact path to your newly downloaded notes.
****
Expand Down Expand Up @@ -490,7 +494,7 @@ image::downloadSelectExample.PNG[width="900"]

* The files would be downloaded one by one from IVLE to your "notes" folder.

* if you entered a mix of invalid and valid file IDs, N*Sync will only only download the correct files, up till it encounters a invalid ID.
* if you entered a mix of invalid and valid file IDs, NSync will only only download the correct files, up till it encounters a invalid ID.

Example: file/0,1,2,90000000,3
if 0,1,2,3 are valid file IDs, only file 0,1,2 will be downloaded.
Expand Down
42 changes: 16 additions & 26 deletions docs/team/leegengyu.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,44 +3,44 @@
:imagesDir: ../images
:stylesDir: ../stylesheets

== PROJECT: AddressBook - Level 4
== PROJECT: NSync

---

== Overview

AddressBook - Level 4 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
NSync was created to help students resolve the issue of scheduling meetings between their peers, team mates and friends.

If you are a student, all you have to do is to key in your time-table (and get your friends to do so as well!) once, and we will find you your common meeting time-slot in a simple and fuss-free manner!

== Summary of contributions

* *Major enhancement*: To be decided.
** What it does: To be decided.
** Justification: ide a convenient way to rectify them.
** Highlights: To be decided.
** Credits: _{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}_
* *Major enhancement*: added the feature to *export and import user details*
** What it does: allows the users to `export` and `import` all information fields of one or more contacts, which includes the name, contact number, email, address and the time-table itself.
** Justification: This feature boosts the productivity of the user significantly, by cutting down the amount of time that he/she has to take to input his/her contacts' details. The user and his/her contacts will only have to key in their contact details and time-tables respectively in a one-time fashion, before exporting their details and sending it to each other for importing.
** Highlights: This enhancement builds upon all of the existing user fields, requiring an in-depth analysis into the workings of the `Logic` and `Model` component. The implementation required coalescing all of a user's details during exporting, as well as decoding it into the respective fields subsequently during importing.

* *Minor enhancement*: To be decided.
* *Minor enhancement*: added a `free` command that allows the user to find the next immediate available time-slot for himself, or his contacts from the current time.

* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] _{give links to collated code files}_
* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] <To be confirmed if we are still using collated code files>

* *Other contributions*:

** Project management:
*** To be added.

** Enhancements to existing features:

** Documentation:
https://github.com[#14]
** Community:

** Tools:

*** Added features coming in v2.0 in the User Guide (Pull Request #<To be added>)

_{you can add/remove categories in the list above}_
** Community:
*** PRs reviewed (with non-trivial review comments): To be added.
*** Contributed to forum discussions: To be added.
*** Reported bugs and suggestions for other teams in the class: To be added.

== Contributions to the User Guide


|===
|_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
|===
Expand All @@ -58,13 +58,3 @@ include::../UserGuide.adoc[tag=dataencryption]
include::../DeveloperGuide.adoc[tag=undoredo]

include::../DeveloperGuide.adoc[tag=dataencryption]


== PROJECT: PowerPointLabs

---

_{Optionally, you may include other projects in your portfolio.}_



0 comments on commit e17e5c4

Please sign in to comment.