;doc: consistent markdown readmes for packages, part 2

This commit is contained in:
Simon Michael 2020-03-22 09:27:34 -07:00
parent 2b15418ddd
commit d59ccb260b
6 changed files with 32 additions and 50 deletions

View File

@ -1,4 +1,4 @@
# hledger README # hledger project README
## lightweight, portable, dependable accounting tools ## lightweight, portable, dependable accounting tools
@ -6,8 +6,7 @@ hledger is a computer program for easily tracking money, time, or other commodit
on unix, mac and windows (and web-capable mobile devices, to some extent). on unix, mac and windows (and web-capable mobile devices, to some extent).
It is first a command-line tool, but there are also terminal and It is first a command-line tool, but there are also terminal and
web interfaces, and a Haskell library web interfaces, and a Haskell library for building your own
(http://hackage.haskell.org/package/hledger-lib) for building your own
programs and scripts (hledger is written in Haskell). hledger was programs and scripts (hledger is written in Haskell). hledger was
inspired by and is largely compatible with Ledger. hledger is free inspired by and is largely compatible with Ledger. hledger is free
software available under the GNU General Public License v3+. software available under the GNU General Public License v3+.
@ -25,7 +24,7 @@ I use it every day to:
Though limited in features, hledger is lightweight, usable and reliable. Though limited in features, hledger is lightweight, usable and reliable.
For some, it is a simpler, less distracting, more future-proof alternative to Quicken or GnuCash. For some, it is a simpler, less distracting, more future-proof alternative to Quicken or GnuCash.
For more, see the website: **<https://hledger.org>** For more, see the home page: **<https://hledger.org>**
## Sponsorship ## Sponsorship

View File

@ -1,3 +1,5 @@
# hledger-install
A lot of specialised knowledge is still needed to be sure of A lot of specialised knowledge is still needed to be sure of
successfully building and installing hledger in all cases. For example: successfully building and installing hledger in all cases. For example:
running stack setup if you don't have a suitable version of ghc.. running stack setup if you don't have a suitable version of ghc..

View File

@ -1,3 +1,10 @@
# hledger-lib
A reusable library containing hledger's core functionality. A reusable library containing hledger's core functionality.
This is used by most hledger* packages for common data parsing,
command line option handling, reporting etc. This is used by most hledger* packages so that they support the same
common file formats, command line options, reports etc.
See also:
the [project README](https://hledger.org/README.html)
and [home page](https://hledger.org).

View File

@ -1,45 +1,9 @@
A curses-style text user interface for the hledger accounting tool. # hledger-ui
hledger-ui is the new name for hledger-vty. Revived in 2015, this A simple curses-style text user interface for the hledger accounting system.
package is intended to be installed as standard by all hledger users,
except those on (native) Windows, where it is not supported.
hledger-ui currently allows browsing the balance, register and print This package currently does not support Microsoft Windows, except in WSL.
reports, with drill-down and scrolling.
See also:
# HACKING the [project README](https://hledger.org/README.html)
and [home page](https://hledger.org).
## Backlog:
```
reg: show historical running balance
acc: fix -H, show historical balances
switch to multibalance report ?
adjust filter
accounts screen
register screen
reg: improve other account names
test showing only real postings when there are reals and virtuals
journal entry view dialog
blog
reg: support -V
redraw on ctrl-l/cmd-r
reload on redraw
reload on screen change
reload on file change
acc: show total
fix --drop
show "modified account names" with --drop or --alias
journal screen
bs/is/cf-ish reports
persistent custom reports
persistent config
search in page
adjust other options
add
edit
custom screens
plugin screens
```

View File

@ -1 +1,9 @@
A basic web UI for hledger data. Intended to be robust and somewhat useful. # 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.
See also:
the [project README](https://hledger.org/README.html)
and [home page](https://hledger.org).

View File

@ -2,4 +2,6 @@
The command-line interface for the hledger accounting system. The command-line interface for the hledger accounting system.
More at **<https://hledger.org>**. See also:
the [project README](https://hledger.org/README.html)
and [home page](https://hledger.org).