Skip to content

Commit

Permalink
Update UserGuide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@sogggy
sogggy authored Nov 9, 2020
1 parent cebfcf9 commit 0d71454
Showing 1 changed file with 1 addition and 72 deletions.
73 changes: 1 addition & 72 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,7 @@ With NUSave, you can create, edit and delete [budgets](#7-glossary) and [expendi
based on your entries to gain useful insights regarding your spending habits.

What's more, NUSave has:
<br/>
<br/>
<br/>

- a **[Command Line Interface (CLI)](#7-glossary)** catered to those who can type fast and prefer to use a keyboard. In other words, you
navigate the application and execute instructions by keying in text-based commands into the [command box](#3-gui-layout) provided.
- a **[Graphical User Interface (GUI)](#7-glossary)** to provide you with a visually appealing and aesthetic user experience. Essentially,
Expand Down Expand Up @@ -161,11 +159,6 @@ Here is the breakdown of an individual budget card:
Figure 3.1.2. Example of a budget card.

Below is a table containing all the components that can be found in a budget card accompanied by their respective purposes:
<br/>
<br/>
<br/>
<br/>
<br/>

Component | Purpose
----------------- | -------
Expand All @@ -186,14 +179,6 @@ Here is how a budget page should look like:
Figure 3.2.1. Example of a budget page view.

Below is a table containing all the components that can be found on a budget page accompanied by their respective purposes:
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>

Component | Purpose
--------- | -------
Expand All @@ -212,14 +197,6 @@ Figure 3.2.2. Example of an expenditure card.

Below is a table containing all the components that can be found in an expenditure card accompanied by their respective purposes:

<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>

Component | Purpose
------------- | -------
Index | The index used to reference this expenditure.
Expand Down Expand Up @@ -407,15 +384,6 @@ Figure 5.2.2.1. Example of using the delete budget command.

Format: `edit INDEX [n/NAME] [p/THRESHOLD]`

<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>

Prefix | Parameters | Requirement | Comments | Constraints |
-------| ---------- | ----------- | -------- | ----------- |
\- | `INDEX` | Required | Index of the budget to be edited | Must be an integer between 1-100 |
Expand Down Expand Up @@ -465,7 +433,6 @@ This will find all budgets with the keyword 'Temasek Hall' in the name of the bu

Figure 5.2.4.1. Example of using the find budgets command.

<br/>
#### 5.2.5. Listing budgets: `list`
(Contributed by Chin Hui)

Expand All @@ -485,16 +452,11 @@ This will display all budgets that are currently stored in NUSave as seen in Fig

Figure 5.2.5.1. Example of using the list budgets command.

<br/>
<br/>
<br/>
<br/>

#### 5.2.6. Sorting budgets: `sort`

(Contributed by Yu Ming)

<br/>
Format: `sort TYPE`

Prefix | Parameters | Requirement | Comments | Constraints |
Expand Down Expand Up @@ -568,10 +530,6 @@ The following commands in this subsection are only available on the budget page.
(Contributed by Song Yu)

Format: `add n/NAME p/PRICE [t/TAG]`
<br/>
<br/>
<br/>
<br/>

Prefix | Parameters | Requirement | Comments | Constraints |
-------| -----------| ------------| -------- | ----------- |
Expand Down Expand Up @@ -620,15 +578,6 @@ Figure 5.3.2.1. Example of delete expenditure command

Format: `edit INDEX [n/NAME] [p/PRICE]`

<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>

Prefix | Parameters | Requirement | Comments | Constraints |
------ | ---------- | ----------- | -------- | ----------- |
\- | `INDEX` | Required | Index of the expenditure displayed on NUSave | Must be an integer between 1-100 |
Expand Down Expand Up @@ -746,13 +695,6 @@ This will close the current budget named "NUS Hackers Monthly Budget" as seen in

Figure 5.3.7.1. Example of using the close budget command.

<br/>
<br/>
<br/>
<br/>
<br/>
<br/>

## 6. Command Summary
(Contributed by Yu Ming)

Expand Down Expand Up @@ -795,14 +737,6 @@ Figure 5.3.7.1. Example of using the close budget command.

You can find the meanings of some special keywords applicable to NUSave over here.

<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>

| Term | Explanation
|---------------------------- |-----------------------------------------------------------------------------------------------------------------------------------
| CLI | Short for Command Line Interface. CLI-based Applications (i.e. NUSave) focuses on processing commands in the form of text entered from the keyboard.
Expand All @@ -816,11 +750,6 @@ You can find the meanings of some special keywords applicable to NUSave over her
| Budget Page | Refers to the page that displays the list of expenditures belonging in a specific budget that is stored in NUSave.
| Threshold | Refers to the target limit that can be spent in that budget.

<br/>
<br/>
<br/>
<br/>

## 8. FAQ
(Contributed by Chin Hui)

Expand Down

0 comments on commit 0d71454

Please sign in to comment.