Skip to content

Commit

Permalink
Merge pull request #187 from SwampertX/yeejian-ug-mockpe
Browse files Browse the repository at this point in the history
Edit UserGuide for Mock PE
  • Loading branch information
yuhongtay authored Nov 1, 2019
2 parents dc0e0fb + e18dd07 commit 80a15de
Showing 1 changed file with 28 additions and 18 deletions.
46 changes: 28 additions & 18 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ image::Ui.png[width="790"]
e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
. Some example commands you can try:

* `listExpenditure` : lists all expenditure
** `addAutoExpenditure` --freq month --desc drinks --amt 11.99 to the guiltTrip.
** `deleteExpenditure 3` : deletes the 3rd contact shown in the expenditure list
* `list` : lists all expenses and income
** `addAutoExp` f/monthly n/drinks amt/11.99 cat/Food to the guiltTrip.
** `deleteAutoExp 3` : deletes the 3rd AutoExpense shown in the AutoExpense list
* `exit` : exits the app

. Refer to <<Features>> for details of each command.
Expand Down Expand Up @@ -95,32 +95,40 @@ Examples:
* `delete 2`
* `delete 4`

==== Adding AutoExpenditure : `addAutoExpenditure`
==== Adding AutoExpense : `addAutoExp`

Adds an automatically recurring expenditure every day/week/month (frequency) with the given description and amount.
Adds an automatically recurring expense every day/week/month (frequency) with the given description and amount.

Format: `addAutoExpenditure --freq <frequency> --desc <description> --amt <expenditure>`
Format: `addAutoExp f/<frequency> n/<description> amt/<expenditure> cat/<category>
[tg/<tag1> tg/<tag2> d/<starting date>]`

Examples:
To list all categories, you can type `listCategory`.

* `addAutoExpenditure --freq month --desc spotify --amt 11.99`
Examples:

* `addAutoExp f/monthly n/spotify amt/11.99 cat/Entertainment`

==== Listing AutoExpenditure : `listAutoExpenditure`
==== Editing AutoExpense : `editAutoExp`

Lists all the current automatically recurring expenditures.
Edits an automatically recurring expense every day/week/month (frequency) with the given description and amount.

Format: `editAutoExpenditure <index> [--freq <frequency>] [--desc <description>] [--amt <expenditure>]`
Format: `editAutoExp <index> [f/<frequency> n/<description> amt/<expenditure> cat/<category>
tg/<tag1> tg/<tag2> d/<starting date>]`

Examples:

* `listAutoExpenditure`
* `editAutoExp 1 amt/5.99 n/spotify student`

==== Deleting AutoExpenditure : `deleteAutoExpenditure`
By default, only future Expenses generated by this AutoExpense will have the modified properties.

==== Deleting AutoExpense : `deleteAutoExp`

Deletes a current automatically recurring expenditure at the given index.

Format: `deleteAutoExpenditure <index>`
Format: `deleteAutoExp <index>`

This command only deletes the AutoExpense and stops future generation of such Expenses.
A `--recursive` flag will be shipped in `v2.0`.

==== Adding Budget : 'addBudget`

Expand Down Expand Up @@ -330,6 +338,8 @@ Example:
* `findBudget cat/business d/2019-09-09: lists each entry in Budget with date of "2019-09-09" and category of business.`
* `findBudget d/2019-09-09 tg/a tg/b: lists each entry in Budget with date of "2019-09-09" and tags of a and b.`

// commenting out for mock PE.
////
=== Organization
==== Creating Tags : 'createTag'
Expand Down Expand Up @@ -371,6 +381,7 @@ Example:
* `deleteTag food`
* `deleteTag food -h`
////

==== Resetting Record : 'reset'
Resets records of expenditure/budget/income/loan.
Expand Down Expand Up @@ -706,10 +717,9 @@ do so.
.. addExpense [--desc <description>] [--tag <tag>] --amt <expenditure>
.. editExpense <index> [--desc <description>] [--tag <tag] [--amt <expenditure>]
.. deleteExpense <index>
.. addAutoExpenditure --freq <frequency> --desc <description> --amt <expenditure>
.. listAutoExpenditure
.. editAutoExpenditure <index> [--freq <frequency>] [--desc <description>] [--amt <expenditure>]
.. deleteAutoExpenditure <index>
.. addAutoExp f/monthly n/spotify amt/11.99 cat/Entertainment
.. editAutoExp 1 amt/5.99 n/spotify student
.. deleteAutoExp <index>
.. addIncome [--desc <description>] --amt <income amount>
.. editIncome <index> [--desc <description> --amt <income amount>] [--tag <tag>]
.. deleteIncome <index>
Expand Down

0 comments on commit 80a15de

Please sign in to comment.