Version 0.010

[chaz/homebank2ledger] / README

diff --git a/README b/README
index df13783dbd13724aa29c5acb0216faaaa8a818c8..97794a6acb756cb90e4e99d0a6b7091120b95220 100644 (file)
--- a/README
+++ b/README
@@ -4,7 +4,7 @@ NAME
 
 VERSION
 
 
 VERSION
 

-    version 0.003
+    version 0.010

 
 SYNOPSIS
 
 
 SYNOPSIS
 


@@ -12,15 +12,15 @@ SYNOPSIS
                         [--version|--help|--manual] [--account-width NUM]
                         [--accounts|--no-accounts] [--payees|--no-payees]
                         [--tags|--no-tags] [--commodities|--no-commodities]
                         [--version|--help|--manual] [--account-width NUM]
                         [--accounts|--no-accounts] [--payees|--no-payees]
                         [--tags|--no-tags] [--commodities|--no-commodities]

-                        [--opening-date DATE] [--default-account STR]
+                        [--opening-date DATE]

                         [--rename-account STR]... [--exclude-account STR]...
 
 DESCRIPTION
 
     homebank2ledger converts HomeBank <http://homebank.free.fr/> files to a
     format usable by Ledger <https://www.ledger-cli.org/>. It can also
                         [--rename-account STR]... [--exclude-account STR]...
 
 DESCRIPTION
 
     homebank2ledger converts HomeBank <http://homebank.free.fr/> files to a
     format usable by Ledger <https://www.ledger-cli.org/>. It can also

-    convert directly to the similar Beancount <http://furius.ca/beancount/>
-    format.
+    convert directly to the similar Beancount
+    <https://beancount.github.io/docs/index.html> format.

 
     This software is EXPERIMENTAL, in early development. Its interface may
     change without notice.
 
     This software is EXPERIMENTAL, in early development. Its interface may
     change without notice.


@@ -58,6 +58,45 @@ DESCRIPTION
     continue to maintain your accounts in HomeBank and use this script to
     also take advantage of the reports Ledger offers.
 
     continue to maintain your accounts in HomeBank and use this script to
     also take advantage of the reports Ledger offers.
 

+INSTALL
+
+    There are several ways to install homebank2ledger to your system.
+
+ using cpanm
+
+    You can install homebank2ledger using cpanm. If you have a local perl
+    (plenv, perlbrew, etc.), you can just do:
+
+        cpanm App::Homebank2Ledger
+
+    to install the homebank2ledger executable and its dependencies. The
+    executable will be installed to your perl's bin path, like
+    ~/perl5/perlbrew/bin/homebank2ledger.
+
+    If you're installing to your system perl, you can do:
+
+        cpanm --sudo App::Homebank2Ledger
+
+    to install the homebank2ledger executable to a system directory, like
+    /usr/local/bin/homebank2ledger (depending on your perl).
+
+ Downloading just the executable
+
+    You may also choose to download homebank2ledger as a single executable,
+    like this:
+
+        curl -OL https://raw.githubusercontent.com/chazmcgarvey/homebank2ledger/solo/homebank2ledger
+        chmod +x homebank2ledger
+
+ For developers
+
+    If you're a developer and want to hack on the source, clone the
+    repository and pull the dependencies:
+
+        git clone https://github.com/chazmcgarvey/homebank2ledger.git
+        cd homebank2ledger
+        make bootstrap      # installs dependencies; requires cpanm
+

 OPTIONS
 
  --version
 OPTIONS
 
  --version


@@ -131,6 +170,15 @@ OPTIONS
 
     Defaults to enabled; use --no-commodities to disable.
 
 
     Defaults to enabled; use --no-commodities to disable.
 

+ --budget
+
+    Enables budget transactions.
+
+    Budget transactions are only supported by the Ledger format (for now).
+    This option is silently ignored otherwise.
+
+    Defaults to enabled; use --no-budget to disable.
+

  --opening-date DATE
 
     Specify the opening date for the "opening balances" transaction. This
  --opening-date DATE
 
     Specify the opening date for the "opening balances" transaction. This


@@ -140,14 +188,6 @@ OPTIONS
     Date must be in the form "YYYY-MM-DD". Defaults to the date of the
     first transaction.
 
     Date must be in the form "YYYY-MM-DD". Defaults to the date of the
     first transaction.
 

- --default-account STR
-
-    Specify the account to use for one-sided transactions (if any).
-    Defaults to "Expenses:No Category".
-
-    A default account may be necessary because with Ledger all transactions
-    are double-entry.
-

  --rename-account STR
 
     Specifies a mapping for renaming accounts in the output. By default
  --rename-account STR
 
     Specifies a mapping for renaming accounts in the output. By default


@@ -232,7 +272,7 @@ CAVEATS
       * I didn't intend to make this a releasable robust product, so it's
       lacking tests.
 
       * I didn't intend to make this a releasable robust product, so it's
       lacking tests.
 

-      * Budgets and scheduled transactions are not (yet) converted.
+      * Scheduled transactions are not (yet) converted.

 
       * There are some minor formatting tweaks I will make (e.g.
       consolidate transaction tags and payees)
 
       * There are some minor formatting tweaks I will make (e.g.
       consolidate transaction tags and payees)