From c6951bf7c62a09509b0e435ff75c5147a2611489 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sun, 22 Mar 2020 10:49:02 -0700 Subject: [PATCH] ;doc: more tweaks to package readmes, hackage descriptions --- hledger-lib/README.md | 1 - hledger-lib/package.yaml | 19 +++++++++++-------- hledger-ui/README.md | 2 +- hledger-ui/package.yaml | 21 +++++++++++---------- hledger-web/README.md | 7 ++++--- hledger-web/package.yaml | 22 ++++++++++++---------- hledger/README.md | 2 ++ hledger/package.yaml | 17 +++++++++-------- 8 files changed, 50 insertions(+), 41 deletions(-) diff --git a/hledger-lib/README.md b/hledger-lib/README.md index abe0ed29f..3d6abc423 100644 --- a/hledger-lib/README.md +++ b/hledger-lib/README.md @@ -1,7 +1,6 @@ # hledger-lib A reusable library containing hledger's core functionality. - This is used by most hledger* packages so that they support the same common file formats, command line options, reports etc. diff --git a/hledger-lib/package.yaml b/hledger-lib/package.yaml index b8eca7312..774b829b1 100644 --- a/hledger-lib/package.yaml +++ b/hledger-lib/package.yaml @@ -1,15 +1,18 @@ name: hledger-lib version: 1.17.99 -synopsis: Core data types, parsers and functionality for the hledger accounting tools +synopsis: A reusable library providing the core functionality of hledger description: | - This is a reusable library containing hledger's core functionality. + A reusable library containing hledger's core functionality. + This is used by most hledger* packages so that they support the same + common file formats, command line options, reports etc. + + hledger is a robust, cross-platform set of tools for tracking money, + time, or any other commodity, using double-entry accounting and a + simple, editable file format, with command-line, terminal and web + interfaces. It is a Haskell rewrite of Ledger, and one of the leading + implementations of Plain Text Accounting. Read more at: + - hledger is a cross-platform program for tracking money, time, or - any other commodity, using double-entry accounting and a simple, - editable file format. It is inspired by and largely compatible - with ledger(1). hledger provides command-line, terminal and web - interfaces, and aims to be a reliable, practical tool for daily - use. category: Finance license: GPL-3 author: Simon Michael diff --git a/hledger-ui/README.md b/hledger-ui/README.md index 4e6691a8b..5a29fefe3 100644 --- a/hledger-ui/README.md +++ b/hledger-ui/README.md @@ -1,7 +1,7 @@ # hledger-ui A simple curses-style text user interface for the hledger accounting system. - +It can be a more convenient way to browse your accounts than the CLI. This package currently does not support Microsoft Windows, except in WSL. See also: diff --git a/hledger-ui/package.yaml b/hledger-ui/package.yaml index ff49b7959..401ce89a5 100644 --- a/hledger-ui/package.yaml +++ b/hledger-ui/package.yaml @@ -1,17 +1,18 @@ name : hledger-ui version : 1.17.99 -synopsis : Terminal user interface for the hledger accounting tool +synopsis : Curses-style terminal interface for the hledger accounting system description : | - This is hledger's terminal interface. - It is simpler and more convenient for browsing data than the command-line interface, - but lighter and faster than hledger-web. + A simple curses-style terminal user interface for the hledger accounting system. + It can be a more convenient way to browse your accounts than the CLI. + This package currently does not support Microsoft Windows, except in WSL. + + hledger is a robust, cross-platform set of tools for tracking money, + time, or any other commodity, using double-entry accounting and a + simple, editable file format, with command-line, terminal and web + interfaces. It is a Haskell rewrite of Ledger, and one of the leading + implementations of Plain Text Accounting. Read more at: + - hledger is a cross-platform program for tracking money, time, or - any other commodity, using double-entry accounting and a simple, - editable file format. It is inspired by and largely compatible - with ledger(1). hledger provides command-line, terminal and web - interfaces, and aims to be a reliable, practical tool for daily - use. category : Finance, Console license : GPL-3 author : Simon Michael diff --git a/hledger-web/README.md b/hledger-web/README.md index 6db12d637..d0ea8084a 100644 --- a/hledger-web/README.md +++ b/hledger-web/README.md @@ -1,8 +1,9 @@ # hledger-web -A simple web-based user interface for the hledger accounting system. -It can be used as a local single-user UI, -or for allowing multi-user read/append/edit access over the web. +A simple web-based user interface for the hledger accounting system, +providing a more modern UI than the command-line or terminal interfaces. +It can be used as a local single-user UI, or as a multi-user UI for +viewing/adding/editing on the web. See also: the [project README](https://hledger.org/README.html) diff --git a/hledger-web/package.yaml b/hledger-web/package.yaml index 7a89f26c5..0cb331da6 100644 --- a/hledger-web/package.yaml +++ b/hledger-web/package.yaml @@ -1,17 +1,19 @@ name: hledger-web version: 1.17.99 -synopsis: Web interface for the hledger accounting tool +synopsis: Web-based user interface for the hledger accounting system description: | - This is hledger's web interface. - It provides a more user-friendly and collaborative UI than the - command-line or terminal interfaces. + A simple web-based user interface for the hledger accounting system, + providing a more modern UI than the command-line or terminal interfaces. + It can be used as a local single-user UI, or as a multi-user UI for + viewing/adding/editing on the web. + + hledger is a robust, cross-platform set of tools for tracking money, + time, or any other commodity, using double-entry accounting and a + simple, editable file format, with command-line, terminal and web + interfaces. It is a Haskell rewrite of Ledger, and one of the leading + implementations of Plain Text Accounting. Read more at: + - hledger is a cross-platform program for tracking money, time, or - any other commodity, using double-entry accounting and a simple, - editable file format. It is inspired by and largely compatible - with ledger(1). hledger provides command-line, terminal and web - interfaces, and aims to be a reliable, practical tool for daily - use. category: Finance license: GPL-3 author: Simon Michael diff --git a/hledger/README.md b/hledger/README.md index a231f8252..3fa0bc3b7 100644 --- a/hledger/README.md +++ b/hledger/README.md @@ -1,6 +1,8 @@ # hledger The command-line interface for the hledger accounting system. +Its basic function is to read a plain text file describing +financial transactions and produce useful reports. See also: the [project README](https://hledger.org/README.html) diff --git a/hledger/package.yaml b/hledger/package.yaml index a7b4c204f..c2c2f7157 100644 --- a/hledger/package.yaml +++ b/hledger/package.yaml @@ -1,17 +1,18 @@ name: hledger version: 1.17.99 -synopsis: Command-line interface for the hledger accounting tool +synopsis: Command-line interface for the hledger accounting system description: | - This is hledger's command-line interface. + The command-line interface for the hledger accounting system. Its basic function is to read a plain text file describing financial transactions and produce useful reports. - hledger is a cross-platform program for tracking money, time, or - any other commodity, using double-entry accounting and a simple, - editable file format. It is inspired by and largely compatible - with ledger(1). hledger provides command-line, terminal and web - interfaces, and aims to be a reliable, practical tool for daily - use. + hledger is a robust, cross-platform set of tools for tracking money, + time, or any other commodity, using double-entry accounting and a + simple, editable file format, with command-line, terminal and web + interfaces. It is a Haskell rewrite of Ledger, and one of the leading + implementations of Plain Text Accounting. Read more at: + + category: Finance, Console license: GPL-3 author: Simon Michael