officereso/budget
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update readme with correct spacing

Browse Source
This commit is contained in:
Quentin Snow 2023-01-17 13:42:09 -06:00
parent b6967e665e
commit ea057e7401
2 changed files with 38 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -1,41 +1,37 @@
Output of budget. Output of budget.
``` ```
Usage: Usage:
budget <action> [options] ... budget <action> [options] ...
Actions: Actions:
-h --help Prints this. -h --help Prints this.
-a --account<=STRING> Management tools for an account. -a --account<=STRING> Management tools for an account.
-c --create<=STRING> Creates a new account with NAME. -c --create<=STRING> Creates a new account with NAME.
-e --earn<=STRING> Add an earning to an account. -e --earn<=STRING> Add an earning to an account.
-p --payment<=STRING> Add a payment to an account. -p --payment<=STRING> Add a payment to an account.
Account Options: [-dvD] Account Options: [-dvD]
-d --delete Deletes specified account. -d --delete Deletes specified account.
--force-delete Deletes the specified account without confirmation. --force-delete Deletes the specified account without confirmation.
-v --value Gets the current value of the account. -v --value Gets the current value of the account.
-D --description<=STRING> Changes the description of the account. -D --description<=STRING> Changes the description of the account.
Create Options: [-d] Create Options: [-d]
-d --description<=STRING> Sets a description for an account. -d --description<=STRING> Sets a description for an account.
Earn Options: -v [-drD] Earn Options: -v [-drD]
-v --value=<FlOAT> Value for earning. -v --value=<FlOAT> Value for earning.
-d --description=<STRING> Description for earning. -d --description=<STRING> Description for earning.
-r --receipt=<PATH> Path to file to store in DB as receipt. -r --receipt=<PATH> Path to file to store in DB as receipt.
-D --date=<dd/mm/yyyy> Date as dd/mm/yyyy. Default will be today. -D --date=<mm/dd/yyyyTHH:MM:SS> Date as dd/mm/yyyyTHH:MM:SS. Default will be today.
-t --time=<hh/mm/ss> 24 hour time as hh/mm/ss. Default will be now.
Payment Options: -v [-drD] Payment Options: -v [-drD]
-v --value=<FlOAT> Value for payment. -v --value=<FlOAT> Value for payment.
-d --description=<STRING> Description for payment. -d --description=<STRING> Description for payment.
-r --receipt=<PATH> Path to file to store in DB as receipt. -r --receipt=<PATH> Path to file to store in DB as receipt.
-D --date=<NUM/NUM/NUM> Date as dd/mm/yyyy. Default will be today. -D --date=<mm/dd/yyyyTHH:MM:SS> Date as dd/mm/yyyyTHH:MM:SS. Default will be today.
-t --time=<hh/mm/ss> 24 hour time as hh/mm/ss. Default will be now.
``` ```
Arguments are processed like blocks with each one terminated by the next Action. For example Arguments are processed like blocks with each one terminated by the next Action. For example
``` ```
budget -cAcct -eAcct -v10.00 -r"./receipt.pdf" -pAcct -v5.50 -r"./payment.pdf" budget -cAcct -eAcct -v10.00 -r"./receipt.pdf" -pAcct -v5.50 -r"./payment.pdf"
``` ````
Does the following in order: Does the following in order:
1. Creates an account named ``Acct`` with no description. Creates an account named Acct with no description.
2. Earns ``10.00`` to it with a receipt. Earns 10.00 to it with a receipt.
3. Pays ``5.50`` to it with a receipt. Pays 5.50 to it with a receipt.

32
src/optHandlers/mainOptHandler.cpp
View File

@ -295,27 +295,27 @@ void MainOptHandler::help() {
std::cout << "Usage:" << std::endl; std::cout << "Usage:" << std::endl;
std::cout << "\tbudget <action> [options] ..." << std::endl; std::cout << "\tbudget <action> [options] ..." << std::endl;
std::cout << "Actions:" << std::endl; std::cout << "Actions:" << std::endl;
std::cout << "\t-h --help Prints this." << std::endl; std::cout << "\t-h --help Prints this." << std::endl;
std::cout << "\t-a --account<=STRING> Management tools for an account." << std::endl; std::cout << "\t-a --account<=STRING> Management tools for an account." << std::endl;
std::cout << "\t-c --create<=STRING> Creates a new account with NAME." << std::endl; std::cout << "\t-c --create<=STRING> Creates a new account with NAME." << std::endl;
std::cout << "\t-e --earn<=STRING> Add an earning to an account." << std::endl; std::cout << "\t-e --earn<=STRING> Add an earning to an account." << std::endl;
std::cout << "\t-p --payment<=STRING> Add a payment to an account." << std::endl; std::cout << "\t-p --payment<=STRING> Add a payment to an account." << std::endl;
std::cout << "Account Options: [-dvD]" << std::endl; std::cout << "Account Options: [-dvD]" << std::endl;
std::cout << "\t-d --delete Deletes specified account." << std::endl; std::cout << "\t-d --delete Deletes specified account." << std::endl;
std::cout << "\t--force-delete Deletes the specified account without confirmation." << std::endl; std::cout << "\t--force-delete Deletes the specified account without confirmation." << std::endl;
std::cout << "\t-v --value Gets the current value of the account." << std::endl; std::cout << "\t-v --value Gets the current value of the account." << std::endl;
std::cout << "\t-D --description<=STRING> Changes the description of the account." << std::endl; std::cout << "\t-D --description<=STRING> Changes the description of the account." << std::endl;
std::cout << "Create Options: [-d]" << std::endl; std::cout << "Create Options: [-d]" << std::endl;
std::cout << "\t-d --description<=STRING> Sets a description for an account." << std::endl; std::cout << "\t-d --description<=STRING> Sets a description for an account." << std::endl;
std::cout << "Earn Options: -v [-drD]" << std::endl; std::cout << "Earn Options: -v [-drD]" << std::endl;
std::cout << "\t-v --value=<FlOAT> Value for earning." << std::endl; std::cout << "\t-v --value=<FlOAT> Value for earning." << std::endl;
std::cout << "\t-d --description=<STRING> Description for earning." << std::endl; std::cout << "\t-d --description=<STRING> Description for earning." << std::endl;
std::cout << "\t-r --receipt=<PATH> Path to file to store in DB as receipt." << std::endl; std::cout << "\t-r --receipt=<PATH> Path to file to store in DB as receipt." << std::endl;
std::cout << "\t-D --date=<mm/dd/yyyyTHH:MM:SS> Date as dd/mm/yyyyTHH:MM:SS. Default will be today." << std::endl; std::cout << "\t-D --date=<mm/dd/yyyyTHH:MM:SS> Date as dd/mm/yyyyTHH:MM:SS. Default will be today." << std::endl;
std::cout << "Payment Options: -v [-drD]" << std::endl; std::cout << "Payment Options: -v [-drD]" << std::endl;
std::cout << "\t-v --value=<FlOAT> Value for payment." << std::endl; std::cout << "\t-v --value=<FlOAT> Value for payment." << std::endl;
std::cout << "\t-d --description=<STRING> Description for payment." << std::endl; std::cout << "\t-d --description=<STRING> Description for payment." << std::endl;
std::cout << "\t-r --receipt=<PATH> Path to file to store in DB as receipt." << std::endl; std::cout << "\t-r --receipt=<PATH> Path to file to store in DB as receipt." << std::endl;
std::cout << "\t-D --date=<mm/dd/yyyyTHH:MM:SS> Date as dd/mm/yyyyTHH:MM:SS. Default will be today." << std::endl; std::cout << "\t-D --date=<mm/dd/yyyyTHH:MM:SS> Date as dd/mm/yyyyTHH:MM:SS. Default will be today." << std::endl;
std::cout << std::endl; std::cout << std::endl;
std::cout << "Arguments are processed like blocks with each one terminated by the next Action. For example" std::cout << "Arguments are processed like blocks with each one terminated by the next Action. For example"