Skip to content

Commit ec3fee1

Browse files
committed
MOD: README.md README.md
1 parent cc55800 commit ec3fee1

File tree

2 files changed

+24
-17
lines changed

2 files changed

+24
-17
lines changed

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,21 @@ to initialize a bashew-based **REPO** with CI/CD you just cloned (cf `3.`)
4949

5050
## 🔥 Usage
5151

52-
Usage: bashew.sh [-h] [-q] [-v] [-f] [-t <tmpd>] [-l <logd>] [-n <name>] <action>
53-
Flags, options and parameters:
54-
-h|--help : [flag] show usage [default: off]
55-
-q|--quiet : [flag] no output [default: off]
56-
-v|--verbose : [flag] output more [default: off]
57-
-f|--force : [flag] do not ask for confirmation (always yes) [default: off]
58-
-t|--tmpd <val>: [optn] folder for temp files [default: .tmp]
59-
-l|--logd <val>: [optn] folder for log files [default: log]
60-
-n|--name <val>: [optn] name of new script or project
61-
<action> : [parameter] action to perform: script/project/init/update
52+
```shell
53+
Program: bashew 1.16.8 by peter@forret.com
54+
Updated: Dec 17 21:28:04 2021
55+
Description: package_description
56+
Usage: bashew [-h] [-q] [-v] [-f] [-l <log_dir>] [-t <tmp_dir>] [-n <name>] <action>
57+
Flags, options and parameters:
58+
-h|--help : [flag] show usage [default: off]
59+
-q|--quiet : [flag] no output [default: off]
60+
-v|--verbose : [flag] output more [default: off]
61+
-f|--force : [flag] do not ask for confirmation (always yes) [default: off]
62+
-l|--log_dir <?> : [option] folder for debug files [default: /Users/pforret/log/bashew]
63+
-t|--tmp_dir <?> : [option] folder for temp files [default: /tmp/bashew]
64+
-n|--name <?> : [option] name of new script or project
65+
<action> : [parameter] action to perform: script/project/init/update
66+
```
6267

6368
### 1. create new bash script (without repo)
6469
```shell
@@ -118,20 +123,24 @@ cd <newname>
118123
## 🚀 Installation
119124

120125
* manually
121-
122-
git clone https://github.com/pforret/bashew.git
123-
ln -s bashew/bashew.sh /usr/local/bin
126+
````shell
127+
git clone https://github.com/pforret/bashew.git
128+
ln -s bashew/bashew.sh /usr/local/bin
129+
````
124130

125131
* or with [basher](https://github.com/basherpm/basher) package manager
132+
[![basher install](https://img.shields.io/badge/basher-install-white?logo=gnu-bash&style=flat)](https://basher.gitparade.com/package/)
126133

127-
basher install pforret/bashew
134+
````shell
135+
basher install pforret/bashew
136+
````
128137

129138
## 🙏 Acknowledgements
130139

131140
* [bash_unit](https://github.com/pgrange/bash_unit): bash unit testing enterprise edition framework (used for CI/CD)
132141
* [shellcheck](https://github.com/koalaman/shellcheck): a static analysis tool for shell scripts (used for CI/CD)
133142
* [bash-boilerplate (2012)](https://github.com/oxyc/bash-boilerplate) on which I based my [bash-boilerplate (2020)](https://github.com/pforret/bash-boilerplate) which eventually became this [bashew](https://github.com/pforret/bashew)
134-
* Documentation from [Google](https://google.github.io/styleguide/shellguide.html), [BashPitfalls](https://mywiki.wooledge.org/BashPitfalls), [Microsoft](https://github.com/microsoft/code-with-engineering-playbook/blob/master/code-reviews/recipes/Bash.md)
143+
* Bash documentation from [Google](https://google.github.io/styleguide/shellguide.html), [BashPitfalls](https://mywiki.wooledge.org/BashPitfalls), [Microsoft](https://github.com/microsoft/code-with-engineering-playbook/blob/master/code-reviews/recipes/Bash.md)
135144

136145
## 🤔 What's that name? Bashew?
137146
* derived from 'bash new'

template/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88

99
# package_name
1010

11-
![package_name](https://github.com/pforret/splashmark/raw/master/examples/size_github.jpg)
12-
1311
package_description
1412

1513
## 🔥 Usage

0 commit comments

Comments
 (0)