On 2022-08-08 14:47:49, Francois Marier wrote:
> This seems very similar to the tldr package:
>
> https://packages.debian.org/stable/tldr
>
> See https://tldr.sh/ for examples.
Yeah, so tldr is similar, but cheat has a number of improvements, from
my perspective.
1. it supports multiple collections of cheats, so you can have your own
set for your site-specific scripts
2. the storage format is YAML instead of markdown (depends on the taste
i guess)
3. that enables support for tags and other niceties that harder to do
in markdown
Overall, cheat doesn't try to replace manpages, it seems like a
different thing. I find the project quite interesting and wonder if we
could use it at work to document stuff quickly that would otherwise be
lost in our wiki.
(because, of course, we don't write man pages for our own tools, which
is probably the problem in the first place here...)
(also, one of the things i find silly with tldr is exactly that: it's
basically rewriting the EXAMPLES section of manpages. instead of working
on tldr, people should contribute EXAMPLES to the manpages!)
(I guess the same argument could be made for cheat as well, of course,
but it feels like it serves a different purpose.)
ymmv
--
Be the change you want to see happen.
- Arleen Lorrance, 1974
