mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-19 10:17:35 +03:00
;doc: tldr: readme updates
This commit is contained in:
parent
8ad803cae7
commit
8a190e2012
@ -1,8 +1,19 @@
|
|||||||
[tldr](https://tldr.sh) provides minimal, example-focussed doc pages for command line tools and their subcommands.
|
[tldr-pages](https://tldr.sh) provides minimal, example-focussed doc pages for command line tools and their subcommands.
|
||||||
It is an excellent project and its contraints and practical focus are a good remedy for endless PTA docs.
|
|
||||||
|
|
||||||
tldr pages are short but worth polishing; they represent a fair bit of effort.
|
tldr pages are short but high value, and a great counterbalance to PTA's verbose docs.
|
||||||
These are links to all hledger-related pages currently in the `tldr` project.
|
So they are worth prioritising and maintaining.
|
||||||
These are crafted first to suit tldr and its reviewers,
|
gutjuri made the first hledger tldr page in 2022, and sm added more in 2024.
|
||||||
but we should try to reuse them elsewhere, eg in command docs,
|
|
||||||
if possible without too much divergence/duplication.
|
This directory has convenient symlinks for accessing the hledger-related tldr pages
|
||||||
|
(if tldr is cloned as a sibling to the hledger project directory).
|
||||||
|
|
||||||
|
The tldr pages are crafted first to suit tldr and its reviewers,
|
||||||
|
but we should try to reuse them elsewhere when there is not too much divergence/duplication.
|
||||||
|
|
||||||
|
If you speak a language other than english, you could contribute translations!
|
||||||
|
It is relatively easy:
|
||||||
|
|
||||||
|
<https://github.com/tldr/tldr/blob/main/CONTRIBUTING.md#translations>
|
||||||
|
|
||||||
|
Here are [all hledger-related tldr pages](https://github.com/search?q=repo%3Atldr-pages%2Ftldr%20hledger&type=code),
|
||||||
|
and here is where to check their [translation status](https://lukwebsforge.github.io/tldri18n).
|
||||||
|
Loading…
Reference in New Issue
Block a user