Proper help text & new README structure #311

Merged
lunny merged 11 commits from noerw/tea:improve-app-help into master 2 years ago
noerw commented 2 years ago
Collaborator
  • rework the help text output of tea, tea help, tea --help, now including a proper description, examples, about, ..
  • group commands by category in the help text
  • add a new (current) demo gif in README
  • replace the Usage section of the README with raw tea help output: IMO having a different text in the readme is a lame excuse to not ship good help in the binary.
  • remotely related: make tea --version output only the version, for enhanced parseability (breaking?)

let me know what you think

preview the new readme here

- rework the help text output of `tea`, `tea help`, `tea --help`, now including a proper description, examples, about, .. - group commands by category in the help text - add a new (current) demo gif in README - replace the `Usage` section of the README with raw `tea help` output: IMO having a different text in the readme is a lame excuse to not ship good help in the binary. - remotely related: make `tea --version` output **only** the version, for enhanced parseability (breaking?) let me know what you think preview the new readme [here](https://gitea.com/noerw/tea/src/branch/improve-app-help)
noerw added the
kind/docs
label 2 years ago
noerw added 8 commits 2 years ago
e0d97450f9
Rework README to include tea help output
4f401abc68
add new demo gif
0e2ba56ab5
Merge branch 'master' into improve-app-help
6543 reviewed 2 years ago
Dismissed
Tea is a command line tool for interacting on one or more Gitea instances.
It uses [code.gitea.io/sdk](https://code.gitea.io/sdk) and interacts with the Gitea API
![demo gif](./demo.gif)
6543 commented 2 years ago
Collaborator

@techknowlogick can you update demo gif on dl.gitea.io with the gif of this pull?

@techknowlogick can you update demo gif on dl.gitea.io with the gif of this pull?
6543 reviewed 2 years ago
Dismissed
README.md Outdated
![demo gif](https://dl.gitea.io/screenshots/tea_demo.gif)
```
tea - command line tool to interact with Gitea
version 0.6.0+17-g1c10f33
6543 commented 2 years ago
Collaborator

version 0.7.0 preview ... or so (should be changed on release)

version 0.7.0 preview ... or so (should be changed on release)
noerw marked this conversation as resolved
6543 reviewed 2 years ago
Dismissed
main.go Outdated
}
var appDescription = `tea is a productivity helper for Gitea. It can be used to manage most entities on one
or multiple Gitea instances, and also provides local helpers like 'tea pull checkout'.
6543 commented 2 years ago
Collaborator
-or multiple Gitea instances, and also provides local helpers like 'tea pull checkout'.
+or multiple Gitea instances and provides local helpers like 'tea pull checkout'.
```diff -or multiple Gitea instances, and also provides local helpers like 'tea pull checkout'. +or multiple Gitea instances and provides local helpers like 'tea pull checkout'.
noerw marked this conversation as resolved
noerw added 1 commit 2 years ago
78c94edaae
code review
noerw added 1 commit 2 years ago
d9124476b7 Merge branch 'master' into improve-app-help
lunny reviewed 2 years ago
Dismissed
README.md Outdated
brew install tea
lunny commented 2 years ago
Owner

I'd like to add ### macOS before these lines and also move them before alphinelinux since this is an official one.

I'd like to add `### macOS` before these lines and also move them before alphinelinux since this is an official one.
noerw marked this conversation as resolved
lunny approved these changes 2 years ago
Dismissed
lunny left a comment
Owner

Otherwise LGTM

Otherwise LGTM
khmarbaise approved these changes 2 years ago
Dismissed
## The official CLI interface for gitea
### the official CLI for gitea
Collaborator

I would suggest to use ### The official CLI for gitea instead.

I would suggest to use `### The official CLI for gitea` instead.
noerw marked this conversation as resolved
noerw added 1 commit 2 years ago
2c6c4dbb0a
restructure installation section
lunny merged commit 43a58bdba1 into master 2 years ago
noerw deleted branch improve-app-help 2 years ago
continuous-integration/drone/pr Build is passing
The pull request has been merged as 43a58bdba1.
Sign in to join this conversation.
Loading…
There is no content yet.