Skip to content

Commit ef31dbe

Browse files
gavinlyonsrepogavinlyonsrepo
committed
updating documentation
1 parent 6eeb56e commit ef31dbe

File tree

13 files changed

+25
-50
lines changed

13 files changed

+25
-50
lines changed

‎README.md‎

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,19 @@ Overview
77
can be imported into shell scripts to create functional and colorful
88
scripts and Terminal users interfaces(TUI).
99
* Author: Gavin Lyons
10+
* Communication: Upstream repo at github site below or [email protected]
11+
* URL: [bashmultitool](https://github.com/gavinlyonsrepo/bashmultitool)
12+
* History: See changelog.md in documentation section for version control history.
13+
* Copyright: Copyright (C) 2018 Gavin Lyons. See LICENSE.md in documentation section.
1014

1115
Table of contents
1216
---------------------------
1317

14-
* [Overview](#overview)
15-
* [Table of contents](#table-of-contents)
1618
* [Installation](#installation)
1719
* [Usage](#usage)
1820
* [Files](#files)
1921
* [Features](#features)
20-
* [Communication](#communication)
2122
* [Dependencies](#dependencies)
22-
* [History](#history)
23-
* [Copyright](#copyright)
2423

2524
Installation
2625
-----------------------------------------------
@@ -52,7 +51,6 @@ cd bashmultitool-1.5
5251
sudo make install
5352
```
5453

55-
5654
Usage
5755
-------------------------------------------
5856
Source the library from your bash shell scripts like so:
@@ -64,7 +62,6 @@ do
6462
source "$MYFILE"
6563
done
6664

67-
6865
```
6966

7067
There are six files in library and they are independent of each other
@@ -73,8 +70,6 @@ dependent on print.
7370

7471
Each file has one function, To access functions from your shell scripts type:
7572

76-
77-
7873
```sh
7974
[functionname] [keyword] [options]
8075
```
@@ -165,27 +160,7 @@ Example Output:
165160

166161

167162
Dependencies
168-
-------------------------------------
169-
1. GNU bash, version 4.4.18-2
163+
------------------------------------
164+
1. GNU bash, version 4.4.20
170165

171166
2. The check website section requires netcat installed. [Netcat](https://en.wikipedia.org/wiki/Netcat)
172-
173-
174-
Communication
175-
-----------
176-
If you should find a bug or you have any other query,
177-
please send a report.
178-
Pull requests, suggestions for improvements
179-
and new features welcome.
180-
* Contact: Upstream repo at github site below or [email protected]
181-
* Upstream repository: [bashmultitool](https://github.com/gavinlyonsrepo/bashmultitool)
182-
183-
History
184-
------------------
185-
* See changelog.md in documentation section for version control history
186-
187-
Copyright
188-
---------
189-
Copyright (C) 2018 Gavin Lyons MIT expat
190-
See LICENSE.md in documentation section
191-
for more details

‎documentation/bmtData.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
| Library file | Function | Sections | Content | Doc link |
1+
| Library file | Function | Sections | Content | help file |
22
| ---- | ---- | ---- | ---- | ---- |
3-
| bmtData | btmDataFunc | 601-606 | Data related | [bmtData help file](documentation/bmtData.md)|
3+
| bmtData | btmDataFunc | 601-606 | Data related | bmtData.md|
44

55
601) integer input check
66

‎documentation/bmtFiles.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
| Library file | Function | Sections | Content | Doc link |
1+
| Library file | Function | Sections | Content | help file|
22
| ---- | ---- | ---- | ---- | ---- |
3-
| bmtFiles | bmtFilesFunc | 501-505 | File related | [bmtFiles help file](documentation/bmtFiles.md)|
3+
| bmtFiles | bmtFilesFunc | 501-505 | File related | bmtFiles.md |
44

55
501) Make formated directory
66

‎documentation/bmtLinux.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
| Library file | Function | Sections | Content | Doc link |
1+
| Library file | Function | Sections | Content | help file|
22
| ---- | ---- | ---- | ---- | ---- |
3-
| bmtLinux | bmtLinuxFunc | 401-404 | Linux related | [bmtLinux help file](documentation/bmtLinux.md)|
3+
| bmtLinux | bmtLinuxFunc | 401-404 | Linux related | bmtLinux.md |
44

55

66
401) Check package installed

‎documentation/bmtMisc.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
| Library file | Function | Sections | Content | Doc link |
1+
| Library file | Function | Sections | Content | help file |
22
| ---- | ---- | ---- | ---- | ---- |
3-
| bmtMisc | bmtMiscFunc | 301-303 | Miscellaneous | [bmtMisc help file](documentation/bmtMisc.md)|
3+
| bmtMisc | bmtMiscFunc | 301-303 | Miscellaneous | bmtMisc.md |
44

55
301) Check website up
66

‎documentation/bmtPrint.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
| Library file | Function | Sections | Content | Doc link |
1+
| Library file | Function | Sections | Content | help file |
22
| ---- | ---- | ---- | ---- | ---- |
3-
| bmtPrint | bmtPrintFunc | 101 | Printing text | [bmtPrint help file](documentation/bmtPrint.md)|
3+
| bmtPrint | bmtPrintFunc | 101 | Printing text | bmtPrint.md |
44

55
101) Colored printed text
66

‎documentation/bmtPrompt.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
| Library file | Function | Sections | Content | Doc link |
1+
| Library file | Function | Sections | Content | help file |
22
| ---- | ---- | ---- | ---- | ---- |
3-
| bmtPrompt | bmtPromptFunc | 201-207 | Prompts | [ bmtPrompt help file](documentation/bmtPrompt.md)|
3+
| bmtPrompt | bmtPromptFunc | 201-207 | Prompts | bmtPrompt.md|
44

55

66
201) Horizontal lines across terminal of single character
@@ -19,7 +19,7 @@ Keyword is yesnoquit , returns codes based on user input
1919

2020
```sh
2121
echo "Do you want to foo? [y/n/q] :"
22-
bmtPromptFunc yesno
22+
bmtPromptFunc yesnoquit
2323
```
2424
Returns 0 for yes , 2 for no , 3 for quit
2525

‎test/testdata.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
#====================FUNCTIONS===============================
99
#Source the lib
10-
LIBPATH="/home/gavin/Documents/Tech/Linux/Scripts/BashMultiTool/lib/"
10+
LIBPATH="/home/gavin/Documents/Tech/Scripts/BashMultiTool/lib/"
1111
for MYFILE in "$LIBPATH"*;
1212
do
1313
source "$MYFILE"

‎test/testfile.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
#====================FUNCTIONS===============================
99
#Source the lib
10-
LIBPATH="/home/gavin/Documents/Tech/Linux/Scripts/BashMultiTool/lib/"
10+
LIBPATH="/home/gavin/Documents/Tech/Scripts/BashMultiTool/lib/"
1111
for MYFILE in "$LIBPATH"*;
1212
do
1313
source "$MYFILE"

‎test/testlinux.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
#====================FUNCTIONS===============================
99
#Source the lib
10-
LIBPATH="/home/gavin/Documents/Tech/Linux/Scripts/BashMultiTool/lib/"
10+
LIBPATH="/home/gavin/Documents/Tech/Scripts/BashMultiTool/lib/"
1111
for MYFILE in "$LIBPATH"*;
1212
do
1313
source "$MYFILE"

0 commit comments

Comments
 (0)