interesting
/
template-bash-command
mirror of https://github.com/rwxrob/template-bash-command.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix command title heading level

This commit is contained in:
rwxrob 2021-08-09 10:22:17 -04:00
parent 4aca3660b7
commit d7afbb80fb
No known key found for this signature in database
GPG Key ID: 1CCACEDD2F65578E
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,17 +1,16 @@
# Bash Command Template # Bash Command Template
This is a GitHub template repo that will be copied instead of forked This is a GitHub template repo that will be copied instead of forked to
to create a new Bash command with a command something like this: create a new Bash command with a command something like this:
``` ```
gh repo create rwxrob/mycmd -p rwxrob/bash-command-template gh repo create rwxrob/mycmd -p rwxrob/template-bash-command
``` ```
Obviously, not all of this is needed for Obviously, not all of this is needed for many Bash scripts, but anything
many Bash scripts, but anything with more than two subcommands will with more than two subcommands will benefit from the builtin tab
benefit from the builtin tab completion, embedded Markdown help completion, embedded Markdown help documentation support, and included
documentation support, and included functions (`usage`, `_filter`, functions (`usage`, `_filter`, `_filterbuf`, `_have`, etc.)
`_filterbuf`, `_have`, etc.)
## Installation ## Installation
@ -20,18 +19,19 @@ path to this repo to your `PATH`. That way you can keep up with updates.
## Naming Conventions ## Naming Conventions
* Name repo beginning with `cmd-` to help distinguish them * Name repos containing single bash commands with `cmd-`
* Name template repos beginning with `template-`
* Start command functions with `x_` to be completed * Start command functions with `x_` to be completed
* Start command functions with `x__` to not be completed * Start command functions with `x__` to not be completed
## Usage ## Usage
``` ```
example cmd
example usage cmd usage
example help [<cmd>] cmd help [<cmd>]
example foo [<arg>] cmd foo [<arg>]
example bar [<arg>] cmd bar [<arg>]
``` ```
## Commands ## Commands
@ -62,11 +62,11 @@ is written in CommonMark (Markdown) and will displayed as Web page if
`pandoc` and `$HELP_BROWSER` are detected, otherwise, just the Markdown is `pandoc` and `$HELP_BROWSER` are detected, otherwise, just the Markdown is
sent to `$PAGER` (default: `more`). sent to `$PAGER` (default: `more`).
## `foo` ### `foo`
The `foo` command foos. The `foo` command foos.
## `bar` ### `bar`
The `bar` command bars. The `bar` command bars.