Proper help text & new README structure #311

Merged
lunny merged 11 commits from noerw/tea:improve-app-help into master 2020-12-21 13:37:21 +00:00

11 Commits

Author SHA1 Message Date
Norwin 2c6c4dbb0a
restructure installation section
All checks were successful
continuous-integration/drone/pr Build is passing
2020-12-18 08:36:13 +01:00
Norwin d9124476b7 Merge branch 'master' into improve-app-help
All checks were successful
continuous-integration/drone/pr Build is passing
2020-12-18 03:24:56 +08:00
Norwin 78c94edaae
code review
All checks were successful
continuous-integration/drone/pr Build is passing
2020-12-17 20:13:27 +01:00
Norwin 0e2ba56ab5
Merge branch 'master' into improve-app-help
All checks were successful
continuous-integration/drone/pr Build is passing
2020-12-17 15:55:10 +01:00
Norwin a2ba019c7a
readme improvement 2020-12-16 05:17:40 +01:00
Norwin 4f401abc68
add new demo gif
shows the (probably) most useful workflow
2020-12-16 05:10:59 +01:00
Norwin 1513d64a30
group commands by category 2020-12-15 20:26:58 +01:00
Norwin e0d97450f9
Rework README to include tea help output
It's an antipattern to have different help texts aimed at the same
users. So now that we have a good cli help text, lets use it here.
This eases maintenance, and at the same time gives an honest impression
on what we have to offer, while also encouraging to improve the internal
help text in the future.

I feel a bit sad for the GIF, but it was becoming outdated anyway..
2020-12-15 20:26:58 +01:00
Norwin 9667984eb0
tea --version : improve parseability 2020-12-15 20:26:58 +01:00
Norwin f8f31bb647
customize tea help view 2020-12-15 18:56:35 +01:00
Norwin 946162b6fe
add cli.AppHelpTemplate for customization 2020-12-15 18:56:35 +01:00