Skip to content

Commit

Permalink
Merge pull request nusCS2113-AY1819S1#79 from leegengyu/master
Browse files Browse the repository at this point in the history
Updated README/UserGuide/DeveloperGuide
  • Loading branch information
leegengyu authored Oct 30, 2018
2 parents 0fc0244 + eee4304 commit 33b0d67
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 11 deletions.
11 changes: 5 additions & 6 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -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]]
Expand All @@ -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

* <<UserGuide#, User Guide>>
* <<DeveloperGuide#, Developer Guide>>
* <<LearningOutcomes#, Learning Outcomes>>
* <<AboutUs#, About Us>>
* <<ContactUs#, Contact Us>>

== 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]

10 changes: 5 additions & 5 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= NSync - User Guide
= N*Sync - User Guide
:site-section: UserGuide
:toc:
:toc-title:
Expand All @@ -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 <<Quick Start>> to get started. Enjoy!

== Quick Start
Expand All @@ -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/[email protected] 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 <<Features>> for details of each command.
Expand Down Expand Up @@ -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
Expand Down
Binary file modified docs/images/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 33b0d67

Please sign in to comment.