Skip to content

Commit 29a8d26

Browse files
update docs
1 parent afb7b22 commit 29a8d26

File tree

6 files changed

+15
-28
lines changed

6 files changed

+15
-28
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
TODO
1+
stuff/
File renamed without changes.

README.md

Lines changed: 14 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,19 @@
1-
21
Overview
32
--------------------------------------------
4-
* Name: bashmultitool
5-
* Title : Bash Shell library for commonly used functions.
3+
* Name: bashMultiTool
64
* Description: A Bash Shell library file for commonly used functions
75
can be imported into shell scripts to create functional and colorful
86
scripts and Terminal users interfaces(TUI).
97
* 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.
148

159
Table of contents
1610
---------------------------
1711

1812
* [Installation](#installation)
13+
* [Dependencies](#dependencies)
1914
* [Usage](#usage)
2015
* [Files](#files)
21-
* [Features](#features)
22-
* [Communication](#communication)
23-
* [Dependencies](#dependencies)
24-
16+
* [Software](#software)
2517

2618
Installation
2719
-----------------------------------------------
@@ -56,6 +48,12 @@ sudo make install
5648

5749
It's also available in the Arch Linux user repo AUR
5850

51+
Dependencies
52+
-------------------------------------
53+
1. GNU bash, version 4.4.18-2
54+
55+
2. The check website section requires netcat installed. [Netcat](https://en.wikipedia.org/wiki/Netcat)
56+
5957
Usage
6058
-------------------------------------------
6159
Source the library from your bash shell scripts like so:
@@ -111,7 +109,7 @@ Files and setup
111109
| bmtData | btmDataFunc | 601-606 | Data related | [bmtData help file](documentation/bmtData.md)|
112110

113111

114-
Features
112+
Software
115113
----------------------
116114
The library contains six files and six functions,
117115
which contains 27 sections in total.
@@ -126,14 +124,12 @@ data related and miscellaneous.
126124

127125
Colours: Black, Red, Green, Yellow, Blue, Purple, Cyan, White.
128126

129-
Modes: normal, bold, underline, background, hiy, bold hiy, background hiy.
130-
131-
Note: hiy = high intensity.
132-
127+
Modes: normal, bold, underline, background, high intensity,
128+
bold high intensity, background high intensity.
129+
133130
Example Output:
134131

135-
![ScreenShot](https://raw.githubusercontent.com/gavinlyonsrepo/bashmultitool/master/screenshot/colour_print_example.png)
136-
132+
![ScreenShot](https://raw.githubusercontent.com/gavinlyonsrepo/bashmultitool/master/documentation/screenshot/colour_print_example.png)
137133

138134
* 201 Horizontal lines across terminal in any colour
139135
* 202 yes-no-quit [y/n/q] prompt
@@ -165,12 +161,3 @@ Example Output:
165161
* 604 convert string to lowercase
166162
* 605 convert string to uppercase
167163
* 606 trim whitespace from string
168-
169-
170-
Dependencies
171-
-------------------------------------
172-
1. GNU bash, version 4.4.18-2
173-
174-
2. The check website section requires netcat installed. [Netcat](https://en.wikipedia.org/wiki/Netcat)
175-
176-
File renamed without changes.

0 commit comments

Comments
 (0)