diff --git a/README.adoc b/README.adoc index 32527e6ea2e8..5c1e081c9753 100644 --- a/README.adoc +++ b/README.adoc @@ -1,4 +1,4 @@ -= NUSync += N*Sync 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]] @@ -12,23 +12,22 @@ ifndef::env-github[] image::images/Ui.png[width="600"] endif::[] -* This is a desktop Address Book and utility application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface). -* It is a Java application intended for NUS students to simplify parts of their daily routines, such as arranging a common timeslot with friends, and downloading their notes from IVLE. +* 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. +* 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 * <> * <> -* <> * <> * <> == Acknowledgements -* This application is built on the sample application https://github.com/nusCS2113-AY1819S1/addressbook-level4[Address Book (Level 4)] +* This application is built on the sample application https://github.com/nusCS2113-AY1819S1/addressbook-level4[Address Book (Level 4)]. * Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by _Marco Jakob_. -* Libraries used: https://github.com/TestFX/TestFX[TextFX], https://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5] +* Libraries used: https://github.com/TestFX/TestFX[TextFX], https://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]. == Licence : link:LICENSE[MIT] diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 06586145b53e..1cbed4bd89ff 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -1,4 +1,4 @@ -= NSync - User Guide += N*Sync - User Guide :site-section: UserGuide :toc: :toc-title: @@ -15,11 +15,11 @@ ifdef::env-github[] endif::[] :repoURL: https://github.com/se-edu/addressbook-level4 -By: `Team W12-2` Since: `Aug 2018` Licence: `MIT` +By: `CS2113-AY1819S1-W12-2` Since: `Aug 2018` Licence: `MIT` == Introduction -NSync is a program for NUS students who *strive to keep their lives organised, despite their busy schedules*. +N*Sync is a program for NUS students who *strive to keep their lives organised, despite their busy schedules*. Interested? Jump to the <> to get started. Enjoy! == Quick Start @@ -37,7 +37,7 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window. * *`list`* : lists all contacts * **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : adds a contact named `John Doe` to the Address Book. -* **`delete`**`3` : deletes the 3rd contact shown in the current list +* **`delete`**`3` : deletes contact whose index number is 3 * *`exit`* : exits the app . Refer to <> for details of each command. @@ -441,7 +441,7 @@ Format: clearNotes // tag::dataencryption[] === Encrypting data files `[coming in v2.0]` -_{explain how the user can enable/disable data encryption}_ +Coming to you soon! // end::dataencryption[] == FAQ diff --git a/docs/images/Ui.png b/docs/images/Ui.png index 9c8bd4a132f0..e3478ae4a175 100644 Binary files a/docs/images/Ui.png and b/docs/images/Ui.png differ