Skip to content

Commit f14429a

Browse files
edit readme
1 parent 1d4e6c5 commit f14429a

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Software
8080

8181
Eight separate markdown help files with detailed information,
8282
in documentation folder are available.
83-
For shortcut to each help file click on link in 2nd table in *software* section below. The repo also contains a *test folder* where test files used in development are available, one for each library file.
83+
For shortcut to each help file click on link in 2nd table below.
8484
A script to print library meta data is also installed.
8585

8686
| Installed File Path | Description |
@@ -100,7 +100,7 @@ A script to print library meta data is also installed.
100100
| bmtData | btmDataFunc | 601-607 | Data related | [bmtData help file](documentation/bmtData.md)|
101101
| bmtTime | btmTimeFunc | 701-709 | Time related | [bmtTime help file](documentation/bmtTime.md)|
102102
| bmtMisc | bmtMiscFunc | 801-804 | Miscellaneous | [bmtMisc help file](documentation/bmtMisc.md)|
103-
| bmtTest | bmtTestFunc | 901 | Test the library | [bmtTest help file](documentation/bmtTest.md)|
103+
| bmtTest | bmtTestFunc | 901 | library testing | [bmtTest help file](documentation/bmtTest.md)|
104104

105105
The library contains eight section's, Each section has one file with one function.
106106
Which contains 50 sub-sections in total.
@@ -109,7 +109,9 @@ Printing, prompting, Linux related, file related,
109109
data related, time related , network related and miscellaneous.
110110
The sections are mostly independent of each other
111111
you can source them individually if you wish, however the prompt file *is*
112-
dependent on print. Each file has one function,
112+
dependent on print. There is also a ninth test section bmtTest used to test library.
113+
114+
The repo also contains a *test folder* where test files used in development are available, one for each library file. There is also a testTest.sh which runs an semi-automated test on entire library and produces a report.
113115

114116
Example
115117
----------------------------
@@ -118,6 +120,6 @@ Output of basic example file in example folder, showing basic usage.
118120

119121
![ScreenShot](https://raw.githubusercontent.com/gavinlyonsrepo/bashmultitool/master/documentation/screenshot/example.png)
120122

121-
Output report of test section.
123+
Output report of test script testTest.sh.
122124

123125
![ScreenShot](https://raw.githubusercontent.com/gavinlyonsrepo/bashmultitool/master/documentation/screenshot/test.png)

0 commit comments

Comments
 (0)