From 5ebfca71763949d17e0f398c2385cb5c3991a9af Mon Sep 17 00:00:00 2001 From: Martin Kobetic Date: Mon, 1 Apr 2024 23:18:09 -0400 Subject: [PATCH 01/10] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 89ae63e..c3f9ccd 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,10 @@ generates ledger samples for testing or demos, see [`cmd/gen2coin/README.md`](ht converts the ledger into a single-page html viewer, see [`cmd/coin2html/README.md`](https://github.com/mkobetic/coin/blob/master/cmd/coin2html/README.md) +![Register Full](https://github.com/mkobetic/coin/assets/871693/8bc5704e-cd03-42c0-b4ca-828c51f8fec8) + +![Chart Monthly](https://github.com/mkobetic/coin/assets/871693/d640b4a4-1cd2-4faf-8fbd-0c10f3cc90b3) + ## Assorted Ledger Differences (besides vastly reduced set of commands/options and capabilities) From f122175c3aaa79c11c0ecfc6daeb849b66659210 Mon Sep 17 00:00:00 2001 From: Martin Kobetic Date: Mon, 1 Apr 2024 23:19:37 -0400 Subject: [PATCH 02/10] Update README.md --- cmd/coin2html/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/cmd/coin2html/README.md b/cmd/coin2html/README.md index 416b99e..cd5143e 100644 --- a/cmd/coin2html/README.md +++ b/cmd/coin2html/README.md @@ -10,11 +10,15 @@ Displayed transactions are restricted to selected time range. Shows the transaction details in tabular form +![Register Full](https://github.com/mkobetic/coin/assets/871693/d25a6cd8-9775-4261-a601-3d2173ec8a6c) + ## SubAccounts When un-checked only transactions for the selected account are shown. When checked transaction of the account and any subaccounts are shown. +![Register Aggregated Monthly](https://github.com/mkobetic/coin/assets/871693/ca4897e1-54f3-4d94-93c7-c054b925f566) + ## Aggregate When None, the individual transactions are shown. @@ -24,3 +28,5 @@ When aggregated with subaccounts, the SubAccount Max option controls how many "t # Chart View Chart shows aggregated transactions (including subaccounts) by the selected aggregation period as a bar chart. The meaning of the available options is the same as for the Register aggregations. + +![Chart Monthly](https://github.com/mkobetic/coin/assets/871693/7e265e93-131b-4a9e-b1db-3b201a53092b) From f2fe033af1aeb3d2d30bf1c5ba0442847cee65ff Mon Sep 17 00:00:00 2001 From: Martin Kobetic Date: Mon, 1 Apr 2024 23:22:26 -0400 Subject: [PATCH 03/10] Update README.md --- cmd/coin2html/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/cmd/coin2html/README.md b/cmd/coin2html/README.md index cd5143e..f5e7b58 100644 --- a/cmd/coin2html/README.md +++ b/cmd/coin2html/README.md @@ -17,7 +17,7 @@ Shows the transaction details in tabular form When un-checked only transactions for the selected account are shown. When checked transaction of the account and any subaccounts are shown. -![Register Aggregated Monthly](https://github.com/mkobetic/coin/assets/871693/ca4897e1-54f3-4d94-93c7-c054b925f566) +![Register Full With SubAccounts](https://github.com/mkobetic/coin/assets/871693/011f46e4-2f1d-4566-ac6a-58f7b4b8d66f) ## Aggregate @@ -25,6 +25,8 @@ When None, the individual transactions are shown. When not None, the transactions are aggregated by the selected aggregation period (Weekly, Monthly, Quarterly, Yearly). When aggregated with subaccounts, the SubAccount Max option controls how many "top" subaccounts should be shown; the rest of the subaccounts are combined into an "Other" column. Top means the subaccounts with the highest average transaction value across the time range. +![Register Aggregated Monthly](https://github.com/mkobetic/coin/assets/871693/ca4897e1-54f3-4d94-93c7-c054b925f566) + # Chart View Chart shows aggregated transactions (including subaccounts) by the selected aggregation period as a bar chart. The meaning of the available options is the same as for the Register aggregations. From 1ad741b16d32a68adcbdb59433166da1197f4909 Mon Sep 17 00:00:00 2001 From: Martin Kobetic Date: Mon, 1 Apr 2024 23:26:55 -0400 Subject: [PATCH 04/10] Update README.md --- cmd/coin2html/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/cmd/coin2html/README.md b/cmd/coin2html/README.md index f5e7b58..1323c75 100644 --- a/cmd/coin2html/README.md +++ b/cmd/coin2html/README.md @@ -1,4 +1,5 @@ Converts the coin database into an HTML doc with a single page, interactive JS app for viewing. +Check out the [example/yearly](example/yearly/viewer.html) Account hierarchy nav on the left, segregated by account type (Assets, Income, Expenses, Liabilities, Equity). Selecting a specific account restricts the detail view to that account's hierarchy. From 1c0baf0dfee788cf41500bff5d21c11e915e2b97 Mon Sep 17 00:00:00 2001 From: Martin Kobetic Date: Mon, 1 Apr 2024 23:28:29 -0400 Subject: [PATCH 05/10] Update README.md --- cmd/coin2html/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/coin2html/README.md b/cmd/coin2html/README.md index 1323c75..8c35c03 100644 --- a/cmd/coin2html/README.md +++ b/cmd/coin2html/README.md @@ -1,5 +1,5 @@ Converts the coin database into an HTML doc with a single page, interactive JS app for viewing. -Check out the [example/yearly](example/yearly/viewer.html) +Check out the [example/yearly](../../example/yearly/viewer.html) Account hierarchy nav on the left, segregated by account type (Assets, Income, Expenses, Liabilities, Equity). Selecting a specific account restricts the detail view to that account's hierarchy. From 082dafdfa877b15cd596ed6d88964cf32ce9bf3b Mon Sep 17 00:00:00 2001 From: Martin Kobetic Date: Mon, 1 Apr 2024 23:29:28 -0400 Subject: [PATCH 06/10] Update README.md --- cmd/coin2html/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/coin2html/README.md b/cmd/coin2html/README.md index 8c35c03..9993866 100644 --- a/cmd/coin2html/README.md +++ b/cmd/coin2html/README.md @@ -1,5 +1,5 @@ Converts the coin database into an HTML doc with a single page, interactive JS app for viewing. -Check out the [example/yearly](../../example/yearly/viewer.html) +Check out the [example/yearly](/examples/yearly/viewer.html) Account hierarchy nav on the left, segregated by account type (Assets, Income, Expenses, Liabilities, Equity). Selecting a specific account restricts the detail view to that account's hierarchy. From a7dcfde23a8277aeb7e2d0b817d3cf599680110a Mon Sep 17 00:00:00 2001 From: Martin Kobetic Date: Mon, 1 Apr 2024 23:53:55 -0400 Subject: [PATCH 07/10] push example/yearly/viewer.html to github pages --- .github/workflows/static.yml | 43 ++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .github/workflows/static.yml diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 0000000..dbf329c --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,43 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy static content to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["master"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: 'examples/yearly/viewer.html' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 From 8f443bd004f8900ba5cd1cc872648825f4e29715 Mon Sep 17 00:00:00 2001 From: Martin Kobetic Date: Tue, 2 Apr 2024 00:04:02 -0400 Subject: [PATCH 08/10] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c3f9ccd..d4a80d4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +![tests](https://github.com/mkobetic/coin/.github/workflows/test.yml/badge.svg) + **NB:** This is still a work in progress, a lot of information is missing and is filled in gradually. There isn't much in terms of user documentation, but most features follow the same pattern as ledger-cli. You can learn most things from ledger-cli's excellent documentation. Coin is a heavily simplified offshoot of [ledger-cli.org](https://www.ledger-cli.org/). The idea of [plain text accounting](https://plaintextaccounting.org/) is brilliant, and ledger implements it beautifully. However ledger makes certain fundamental tradeoffs that have implications that some may find undesirable. For example its extreme flexibility in how amounts and commodities can be written (prefix/postfix/symbolic etc) forces commodities that include numbers to be quoted. That gets annoying when your ledger includes a lot of mutual fund names. Coin sacrifices this flexibility to avoid quoting. From 23638b9958284f339bbf4f53de46e84fb5bbd7a9 Mon Sep 17 00:00:00 2001 From: Martin Kobetic Date: Tue, 2 Apr 2024 00:05:33 -0400 Subject: [PATCH 09/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d4a80d4..f517710 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![tests](https://github.com/mkobetic/coin/.github/workflows/test.yml/badge.svg) +![tests](https://github.com/mkobetic/coin/actions/workflows/test.yml/badge.svg) **NB:** This is still a work in progress, a lot of information is missing and is filled in gradually. There isn't much in terms of user documentation, but most features follow the same pattern as ledger-cli. You can learn most things from ledger-cli's excellent documentation. From 678915eba5327e3e14b163ddbd17108b3e293370 Mon Sep 17 00:00:00 2001 From: Martin Kobetic Date: Tue, 2 Apr 2024 00:06:08 -0400 Subject: [PATCH 10/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f517710..2ce337d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![tests](https://github.com/mkobetic/coin/actions/workflows/test.yml/badge.svg) +![tests](https://github.com/mkobetic/coin/actions/workflows/test.yaml/badge.svg) **NB:** This is still a work in progress, a lot of information is missing and is filled in gradually. There isn't much in terms of user documentation, but most features follow the same pattern as ledger-cli. You can learn most things from ledger-cli's excellent documentation.