Skip to content

Commit

Permalink
Merge pull request #212 from lipwei1808/branch-UGDG
Browse files Browse the repository at this point in the history 
Refine UG Installation, Add, Help
  • Loading branch information
@lipwei1808
lipwei1808 authored Nov 13, 2023
2 parents d286f24 + dea91e3 commit 97141e1
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Please read through sections [Installation](#installation) and [Command Breakdow

1. Ensure you have Java `11` or above installed in your Computer.

2. Download the latest `unicash.jar` from [GitHub](https://github.com/AY2324S1-CS2103-T16-3/tp/releases/tag/v1.3.1).
2. Download the latest `unicash.jar` from [GitHub](https://github.com/AY2324S1-CS2103-T16-3/tp/releases/latest).

3. Copy the file to the folder you want to use as the _home folder_ for your UniCa$h.

Expand All @@ -36,10 +36,10 @@ Please read through sections [Installation](#installation) and [Command Breakdow

<img src="images/Ui.png" width="650">

5. Type the command in the command box and press `Enter` to execute it. e.g. typing **`help`** and pressing `Enter` will
open the help window.
5. Type a command in the command box and press `Enter` to execute it. e.g. typing `help` and pressing `Enter` will
execute the `help` command and open the help window.

To get started with UniCa$h, you can run the `add_transactions` command!
To get started with UniCa$h, you can run the [`add_transactions` command](#add-transaction)!

6. Refer to the [Features](#features) below for details of each command.

Expand Down Expand Up @@ -91,7 +91,7 @@ Prefixes have several variations with different notations:

**Notes:**

1. Optional fields imply that the _omission_, not the absence of value when used, is supported. This means that `l/` is **_NOT_** an optional parameter, but rather a blank one.
1. Optional fields imply that the _omission_ of the field, not the absence of value when used, is supported. This means that `l/` is **_NOT_** an optional parameter, but rather a blank one.

#### Prefix Types

Expand Down Expand Up @@ -287,6 +287,12 @@ Command: `add_transaction n/NAME type/TYPE amt/AMOUNT [dt/DATETIME] [l/LOCATION]
For more information about the prefix constraints, refer to the [command breakdown's prefix types section](#prefix-types)
</div>

Take note the following prefixes definition overrides the one in the [prefix types section](#prefix-types)

| Prefix | Constraints | Remarks | Valid | Invalid |
|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|-------------------------------------------------------|
| `l/`<br><br>(Location of transaction) | At least 1 character but no more than 500 characters.<br><br>Only supports alphanumeric characters, spaces, (, ), _, @, -, #, &, ., and , characters. | If no value is provided, i.e. `l/`, then it defaults to `-`. | `l/`<br>`l/NTUC @ UTown` | `l/Two ^` |

Command Words Accepted: `add_transaction`, `add`, `at` (case-insensitive)

<div class="callout callout-important" markdown="span" style="margin-bottom: 20px;">
Expand Down Expand Up @@ -333,6 +339,8 @@ There is a limit of 100,000 transactions you can add to UniCa$h.
> Location: -;
> Categories:
> ```
>
> **Remarks**: The value of the `Date` output as shown above could be different from the one displayed in your application. Refer to [prefix types section](#prefix-types) for further elaboration on the omission of the `dt/` prefix.
##### Failed Execution
Expand All @@ -346,7 +354,7 @@ There is a limit of 100,000 transactions you can add to UniCa$h.
> ```
> Invalid command format!
>
> add_transaction: Adds a transaction to UniCa$h.
> add, add_transaction, at: Adds a transaction to UniCa$h.
>
> Parameters: n/NAME type/TYPE amt/AMOUNT dt/DATETIME l/LOCATION [c/CATEGORY]...
>
Expand Down Expand Up @@ -378,6 +386,8 @@ There is a limit of 100,000 transactions you can add to UniCa$h.
**Example 4**
> **Case**: More than 100,000 transactions added.
>
> **Precondition**: UniCa$h already has `100,000` transactions stored.
>
> **Input**: `add n/test amt/300 type/expense`
>
Expand Down Expand Up @@ -1420,11 +1430,11 @@ To get a list of `COMMAND_WORD`, do `help` with no arguments
>
> **Output**:
> ```
> add_transaction: Adds a transaction to UniCa$h.
> add, add_transaction, at: Adds a transaction to UniCa$h.
>
> Parameters: n/Name type/Type amt/Amount [dt/DateTime] [l/Location] [c/Category]...
>
> Example: add_transaction n/Buying groceries type/expense amt/300 dt/18-08-2023 19:30 l/NTUC c/Food
> Example: add n/Buying groceries type/expense amt/300 dt/18-08-2023 19:30 l/NTUC c/Food
> ```
##### Failed Execution
Expand All @@ -1439,11 +1449,11 @@ To get a list of `COMMAND_WORD`, do `help` with no arguments
> ```
> Unknown command
>
> help: Shows UniCa$h general usage instructions and specific command usage by specifying the command word.
> help, h: Shows UniCa$h general usage instructions and specific command usage by specifying the command word.
>
> Argument: Command word specified must be a valid command word present in the help command
> Argument: COMMAND_WORD (must be a valid command word present in the help command)
>
> Example: help add_transaction
> Example: help add
> ```
#### Reset UniCa$h
Expand Down

0 comments on commit 97141e1

Please sign in to comment.