Skip to content

Commit df8cba2

Browse files
Add help for download and source
1 parent 2e95efd commit df8cba2

File tree

2 files changed

+26
-16
lines changed

2 files changed

+26
-16
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,31 @@
22

33
POSIX shell script kit is a file of POSIX helper functions.
44

5-
You simply download the kit file, then source it in your script.
6-
7-
The kit works for bash, zsh, dash, and many other modern Unix shells.
5+
The kit works for bash, zsh, dash, and many more Unix shells.
86

9-
The kit is free libre open source software, created by SixArm.
7+
You simply download the kit file, then source it in your script.
108

119
Constructive feedback is welcome and appreciated.
1210

13-
## Usage
11+
## Download
1412

15-
To download this file:
13+
To download the POSIX shell script kit file:
1614

1715
```sh
1816
curl -O "https://raw.githubusercontent.com/SixArm/posix-shell-script-kit/main/posix-shell-script-kit"
1917
```
2018

21-
To include this file in your own script, in the same directory:
19+
## Source
20+
21+
To use the kit in your own script, you source the kit like this:
22+
23+
```sh
24+
. /your/path/here/posix-shell-script-kit
25+
```
26+
27+
To use the kit in your own script in the same directory, you source the kit like this:
2228

2329
```sh
24-
# Include https://github.com/SixArm/posix-shell-script-kit
2530
. "$(dirname "$(readlink -f "$0")")/posix-shell-script-kit"
2631
```
2732

posix-shell-script-kit

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,31 @@
44
#
55
# POSIX shell script kit is a file of POSIX helper functions.
66
#
7-
# You simply download the kit file, then source it in your script.
8-
#
9-
# The kit works for bash, zsh, dash, and many other modern Unix shells.
7+
# The kit works for bash, zsh, dash, and many more Unix shells.
108
#
11-
# The kit is free libre open source software, created by SixArm.
9+
# You simply download the kit file, then source it in your script.
1210
#
1311
# Constructive feedback is welcome and appreciated.
1412
#
15-
# ## Usage
13+
# ## Download
1614
#
17-
# To download this file:
15+
# To download the POSIX shell script kit file:
1816
#
1917
# ```sh
2018
# curl -O "https://raw.githubusercontent.com/SixArm/posix-shell-script-kit/main/posix-shell-script-kit"
2119
# ```
2220
#
23-
# To include this file in your own script, in the same directory:
21+
# ## Source
22+
#
23+
# To use the kit in your own script, you source the kit like this:
24+
#
25+
# ```sh
26+
# . /your/path/here/posix-shell-script-kit
27+
# ```
28+
#
29+
# To use the kit in your own script, in the same directory, you source the kit like this:
2430
#
2531
# ```sh
26-
# # Include https://github.com/SixArm/posix-shell-script-kit
2732
# . "$(dirname "$(readlink -f "$0")")/posix-shell-script-kit"
2833
# ```
2934
#

0 commit comments

Comments
 (0)