From 8a190e201214d15c763d68b49c7c96ef757336b8 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 24 May 2024 10:28:31 -1000 Subject: [PATCH] ;doc: tldr: readme updates --- doc/tldr/README.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/doc/tldr/README.md b/doc/tldr/README.md index 88f394f27..81d9aee36 100644 --- a/doc/tldr/README.md +++ b/doc/tldr/README.md @@ -1,8 +1,19 @@ -[tldr](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](https://tldr.sh) provides minimal, example-focussed doc pages for command line tools and their subcommands. -tldr pages are short but worth polishing; they represent a fair bit of effort. -These are links to all hledger-related pages currently in the `tldr` project. -These are crafted first to suit tldr and its reviewers, -but we should try to reuse them elsewhere, eg in command docs, -if possible without too much divergence/duplication. +tldr pages are short but high value, and a great counterbalance to PTA's verbose docs. +So they are worth prioritising and maintaining. +gutjuri made the first hledger tldr page in 2022, and sm added more in 2024. + +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: + + + +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).