This repository has been archived by the owner on Mar 5, 2022. It is now read-only.
Pulling examples to the top of README? #336
Comments
|
That would be a great improvement. From some past issues it looks like people are missing it. |
zmwangx
added a commit
to zmwangx/googler
that referenced
this issue
May 26, 2020
The README is too damn long at this point, so prioritize the human friendly part. Also added a few more examples showcasing --from/--to, --videos, and positional argument chaining. Closes jarun#336.
zmwangx
added a commit
to zmwangx/googler
that referenced
this issue
May 26, 2020
The README is too damn long at this point, so prioritize the human friendly part. Also added a few more examples showcasing --from/--to, --videos, and positional argument chaining. Closes jarun#336.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Today’s issue #335 got me thinking, the README is huge right now, and whenever I see an overwhelming README that’s almost like Bash Reference Manual on one single HTML page, I want to see examples. The demo screencast is a start but not everyone is into watching “videos”.
What about pulling the examples section up? I’m thinking between the intro and the TOC (so it becomes a TOC for detailed, technical documentation).
Could also use an example showcasing search phrases being split into arbitrary command line arguments.
The text was updated successfully, but these errors were encountered: