diff --git a/README.md b/README.md index aa74a09..7e9e7bd 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,16 @@ The aim of this tool is to automate the monthly task of transcribing payroll CSV information for Conservancy's 8 (currently) employees into ~ 300 lines of fairly intricate Beancount bookkeeping data. + ## Usage Run with: java -jar import-0.0.8-standalone.jar --csv resources/example-paychex-pay-item-details.csv --date 2023-12-29 --period 'December 2023' --total-fees 206.50 --pay-receipt-no rt:19462/674660 --pay-invoice-no rt:19403/675431 --fees-receipt-no rt:19459/675387 --fees-invoice-no rt:19459/674887 --retirement-receipt-no rt:19403/676724 --retirement-invoice-no rt:19403/675431 -Or use a reduced set of options (missing values will be replaced by "TODO" in the output): +Or simpler (missing options will be replaced by "TODO" in the output): - java -jar import-0.0.8-standalone.jar --csv resources/example-paychex-pay-item-details.csv --date 2023-12-29 --period "December 2023" --total-fees 206.50 + java -jar import-0.0.8-standalone.jar --csv resources/example-paychex-pay-item-details.csv --total-fees 206.50 You can test the output in Beancount by adding the following header entries to define the accounts: @@ -32,20 +33,22 @@ Then run Beancount with: ## Development -The project is set up for development in Emacs and CIDER-mode. Open a source -file and run `cider-jack-in`. - Run tests with: - clojure -M:test + bin/test You can run without building using: - clojure -M -m core --csv resources/example-paychex-pay-item-details.csv --date 2023-12-29 --period "December 2023" --total-fees 206.50 + bin/dev --csv resources/example-paychex-pay-item-details.csv --total-fees 206.50 + +The project is set up for development in Emacs and CIDER-mode. Open a source +file and run `cider-jack-in`. ## Build To build, run: - clj -T:build uber + bin/build + +This will output a JAR file like `target/import-x.x.x-standalone.jar`. diff --git a/bin/build b/bin/build new file mode 100755 index 0000000..a16f8ef --- /dev/null +++ b/bin/build @@ -0,0 +1,2 @@ +#!/usr/bin/env sh +clojure -T:build uber diff --git a/bin/dev b/bin/dev new file mode 100755 index 0000000..9d984aa --- /dev/null +++ b/bin/dev @@ -0,0 +1,2 @@ +#!/usr/bin/env sh +clojure -M -m core "$@"