Skip to content

Commit 89d0960

Browse files
Updating docs(2) and adding placeholder script
1 parent 2fc3bb3 commit 89d0960

File tree

7 files changed

+34
-33
lines changed

7 files changed

+34
-33
lines changed

README.md

Lines changed: 34 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ sudo apt install bashmultitool
4949

5050
Download latest fixed release and run the makefile as per
5151
terminal commands below for version 1.4 latest release at time of writing
52-
Note: is you install with this methodyou will not be informed of updates
52+
Note: If you install with this method you will not be informed of updates
5353
by system.
5454

5555
```sh
@@ -74,15 +74,16 @@ done
7474
```
7575

7676
There are six files in library and they are independent of each other
77-
you can source them individually if you wish, however the prompt file *IS*
77+
you can source them individually if you wish, however the prompt file *is*
7878
dependent on print.
79+
7980
Each file has one function, To access functions from your shell scripts:
8081

8182
[functionname] [keyword] [options]
8283

8384
Six separate markdown help files with detailed information,
8485
in documentation folder are available.
85-
For shortcut to each file click on link in 2nd table in **Files and setup** section below.
86+
For shortcut to each file click on link in 2nd table in *Files and setup* section below.
8687
The repo also contains a test folder where test files used in development are available.
8788

8889
Files and setup
@@ -118,7 +119,7 @@ data related and miscellaneous.
118119

119120
## Section numbered list
120121

121-
101) Coloured printed text, 8 colours, 7 modes. 56 options in total.
122+
101 Coloured printed text, 8 colours, 7 modes. 56 options in total.
122123

123124
Colours: Black, Red, Green, Yellow, Blue, Purple, Cyan, White.
124125

@@ -131,35 +132,35 @@ Example Output:
131132
![ScreenShot](https://raw.githubusercontent.com/gavinlyonsrepo/bashmultitool/master/screenshot/colour_print_example.png)
132133

133134

134-
201) Horizontal lines across terminal in any colour
135-
202) yes-no-quit [y/n/q] prompt
136-
203) YES-no [Y/n] prompt
137-
204) yes-NO [y/N] prompt
138-
205) Anykey to continue prompt in any colour
139-
206) QUIT-no [Q/n] prompt
140-
207) quit-NO [q/N] prompt
141-
142-
301) Check if a website is up
143-
302) Spinner Animation for long non-verbose commands
144-
303) Stopwatch / timer
145-
146-
401) Check package installed
147-
402) Linux distro family checker
148-
403) Set text editor $EDITOR if not set
149-
404) log file handler
150-
151-
501) Make and enter a formated directory
152-
502) check if directory exists and empty
153-
503) directory exists
154-
504) file exists
155-
505) device exists
156-
157-
601) integer user input check
158-
602) alphabet user input check
159-
603) alphanumeric user input check
160-
604) convert string to lowercase
161-
605) convert string to uppercase
162-
606) trim whitespace from string
135+
201 Horizontal lines across terminal in any colour
136+
202 yes-no-quit [y/n/q] prompt
137+
203 YES-no [Y/n] prompt
138+
204 yes-NO [y/N] prompt
139+
205 Anykey to continue prompt in any colour
140+
206 QUIT-no [Q/n] prompt
141+
207 quit-NO [q/N] prompt
142+
143+
301 Check if a website is up
144+
302 Spinner Animation for long non-verbose commands
145+
303 Stopwatch / timer
146+
147+
401 Check package installed
148+
402 Linux distro family checker
149+
403 Set text editor $EDITOR if not set
150+
404 log file handler
151+
152+
501 Make and enter a formated directory
153+
502 check if directory exists and empty
154+
503 directory exists
155+
504 file exists
156+
505 device exists
157+
158+
601 integer user input check
159+
602 alphabet user input check
160+
603 alphanumeric user input check
161+
604 convert string to lowercase
162+
605 convert string to uppercase
163+
606 trim whitespace from string
163164

164165

165166
Dependencies
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)