Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY1718S1#70 from CS2103AUG2017-W13-B2/w…
Browse files Browse the repository at this point in the history
…eek-10

Week 10 enhancements merged
  • Loading branch information
RonakLakhotia authored Oct 24, 2017
2 parents 9ab7550 + 763f295 commit 9286a59
Show file tree
Hide file tree
Showing 82 changed files with 3,443 additions and 1,751 deletions.
8 changes: 1 addition & 7 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Weaver (Level 4)
= Weaver

image::docs/images/login.png[width="790"]

Expand All @@ -20,17 +20,11 @@ endif::[]
* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
** A more sophisticated GUI that includes a list panel and an in-built Browser.
** More details about each user like Date Of Birth.
** More test cases, including automated GUI testing.
** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
== Site Map

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

Expand Down
8 changes: 6 additions & 2 deletions accounts.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{
"accountsPath" : "accounts.json",
"usernames" : "[email protected], admin,user",
"usernames" : "[email protected],admin,user",
"passwords" : "19980105,admin,user",
"hm" : null
"hm" : {
"[email protected]" : "19980105",
"admin" : "admin",
"user" : "user"
}
}
223 changes: 145 additions & 78 deletions docs/DeveloperGuide.adoc

Large diffs are not rendered by default.

38 changes: 33 additions & 5 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Weaver - User Guide
= Weaver User HandBook
:toc:
:toc-title:
:toc-placement: preamble
Expand All @@ -15,7 +15,20 @@ endif::[]
By: `W13-B2` Since: `Aug 2017` Licence: `MIT`


== Quick Start
== Product Overview

Weaver is a desktop application that has a GUI (Graphical User Interface) but most of the interactions happen using
a Command Line Interface.Weaver is your personalised addressbook that will make your day to day life easier by letting
you access the details over your friends and family members as and when you want them.

== About

This User Guide gives you some basic guidlines that you need to follow to use Weaver.It gives you a brief introduction
of what the product intends to do and how it will benefit you as a user.Since Weaver uses a Command line Interface
you will find below the list of commands and how to execute them in order to use the application.
So lets get Started! +

== Getting started

. Ensure you have Java version `1.8.0_60` or later installed in your Computer.
+
Expand Down Expand Up @@ -304,8 +317,13 @@ The `redo` command fails as there are no `undo` commands executed previously.

*SINCE V1.2*

=== Login / Logout SINCE V1.2

Users now can login using valid accounts. And their files are seperated.

To logout, just click logout in the "file - > logout" button.

=== Customize tags' color : `color`
=== Customize tags' color : `color` SINCE V1.2

Change the color of one or more than one tags. +
Format: `color [c/COLOR] [t/TAG]...`
Expand All @@ -328,7 +346,7 @@ The `color` command fails as `invalid_color` is not supported.
* `color t/not_existing_tag c/yellow` +
The `color` command fails as `not_existing_tag` does not exit in current database.

=== Change font size : `fs`
=== Change font size : `fs` SINCE V1.2

Change the font size of the entire application +
Format: `fs [FONT SIZE]` or `fs [+/-]`
Expand All @@ -349,7 +367,7 @@ Examples:

* `fs -` +

=== Add Photo to contacts : `photo` +
=== Add Photo to contacts : `photo` SINCE V1.2 +

image::MockUp.png[width="790"]

Expand All @@ -368,6 +386,16 @@ this will delete the photo attached with the person at index 1.
****


=== FaceBook Integration (SINCE V1.3)

Helps you view the profile page of a person in your contact list. +

Command Format - `Facebook [INDEX] [USERNAME OF PERSON ON FACEBOOK]` +

e.g. - `facebook 1 ronak.lakhotia`

image::facebook.png[width="790"]

=== Clearing all entries : `clear`

Clears all entries from the address book. +
Expand Down
Loading

0 comments on commit 9286a59

Please sign in to comment.