Proper help text & new README structure (#311)

add cli.AppHelpTemplate for customization

customize tea help view

tea --version : improve parseability

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..

group commands by category

add new demo gif

shows the (probably) most useful workflow

readme improvement

Merge branch 'master' into improve-app-help

code review

Merge branch 'master' into improve-app-help

restructure installation section

Co-authored-by: Norwin Roosen <git@nroo.de>
Reviewed-on: https://gitea.com/gitea/tea/pulls/311
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-by: khmarbaise <khmarbaise@noreply.gitea.io>
Co-Authored-By: Norwin <noerw@noreply.gitea.io>
Co-Committed-By: Norwin <noerw@noreply.gitea.io>

This commit is contained in:

Norwin

2020-12-21 21:37:20 +08:00

committed by

Lunny Xiao

co-authored by

Norwin Roosen

parent 43e9943757

commit 43a58bdba1

17 changed files with 172 additions and 60 deletions

									
										cmd/open.go
									
		+1
		
												View File
												
				@@ -20,6 +20,7 @@ import (

				var CmdOpen = cli.Command{

					Name:        "open",

					Aliases:     []string{"o"},

					Category:    catHelpers,

					Usage:       "Open something of the repository in web browser",

					Description: `Open something of the repository in web browser`,

					Action:      runOpen,