Skip to content

Commit

Permalink
Merge a61b00c into e0345f0
Browse files Browse the repository at this point in the history
  • Loading branch information
AmabelYeo committed Sep 24, 2018
2 parents e0345f0 + a61b00c commit 7a657e3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
1 change: 0 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ image::images/Ui.png[width="600"]
endif::[]

* This is a desktop social welfare event and volunteer management 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.
* The target audience is social welfare organisations that want to better manage their volunteers & events, and gain further statistical insights from the data.
** Manage contacts and events faster than a typical mouse/GUI driven app
Expand Down
9 changes: 7 additions & 2 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ By: `Team W16-2` Since: `Sept 2018` Licence: `MIT`

SocialCare morphs the given AB4 application into a volunteer management system that allows Social Welfare Organisations to better manage their volunteers & events, and gain further statistical insights from the data. +

SocialCare is for organizations which *prefer to use a desktop app for managing their volunteers *. More importantly, SocialCare is *optimized for those who prefer to work with a Command Line Interface* (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, SocialCare can get your volunteer and event management tasks done faster than traditional GUI apps. Interested? Jump to the <<Quick Start>> to get started. Enjoy!
SocialCare is for organizations which *prefer to use a desktop app for managing their volunteers.* More importantly, SocialCare is *optimized for those who prefer to work with a Command Line Interface* (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, SocialCare can get your volunteer and event management tasks done faster than traditional GUI apps. Interested? Jump to the <<Quick Start>> to get started. Enjoy!

== Quick Start

Expand Down Expand Up @@ -129,6 +129,11 @@ Format: `exit`
Switches context to volunteers or events +
Format: `switch`

****
* A context refers to the management screen that users will see.
* Switch would switch the data view and allow the user to switch between two distinct entities: volunteers and events.
****

Examples:

* `switch -e` +
Expand Down Expand Up @@ -184,7 +189,7 @@ Format: `delete INDEX`

Examples:

* `delete 1 +
* `delete 1` +
Deletes the details of the volunteer specified at index 1

=== Event Management
Expand Down

0 comments on commit 7a657e3

Please sign in to comment.