Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
hongshenggg committed Apr 5, 2023
1 parent bf2bda7 commit c2717d8
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# User Guide

BookFace is a desktop GUI application for the students in the National University
of Singapore (NUS) to manage the contact information of the people they meet in the various lessons or clubs that they participate in.
Since NUS Students often take many classes and meet different people. This application helps them to organise their
contacts list for an easier way to set up proper communication channels.

* [Quick Start](#quick-start)
* [Features](#features)
* [Add user contacts](#add-user-contacts-add)
Expand Down Expand Up @@ -36,7 +41,7 @@ Experienced users can delete the sample data and proceed with regular usage.
This section highlights the core features that this application provides, as
well as the necessary guidelines to follow when using the features. The features
generally follow commands of the form `COMMAND_WORD ARGUMENTs`, with each
feature having its own specific `COMMAND_WORD` and required set of `ARGUMENTS`.
feature having its own specific `COMMAND_WORD` and set of `ARGUMENTS`.

> **Note:** Unless otherwise stated in the guidelines for the specific
> feature, arguments placed within brackets ("[" and "]") denotes that the
Expand Down Expand Up @@ -110,7 +115,8 @@ Format: `find PREFIX/KEYWORD [MORE PREFIX/KEYWORD]`
names of the contacts, `p/` searches through the phone number of the contacts, `t/`
searches through the tags of the contact, etc...
* Each prefix must be followed by one and only one keyword. See below for example usage.
* The search is done via the logical ***AND*** operator, i.e., `find n/john t/cs` will return
* Only the contacts that fulfill **all** the requirements in the given
arguments will be displayed, i.e., `find n/john t/cs` will return
the list of contacts where his name is `john` **and** has a tag that contains `cs`.
* The following shows a list of allowed prefixes:
1. `n/` which represents the name
Expand Down

0 comments on commit c2717d8

Please sign in to comment.