Dark-Alex-17/bash-tui-toolkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add tested section

Browse Source
This commit is contained in:
Timo Reymann
2023-02-17 13:01:56 +01:00
committed by GitHub
parent 619fcbc717
commit 37aaf5e5b2
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -5
View File
@@ -6,10 +6,6 @@ bash-tui-toolkit
Toolkit to create simple Terminal UIs using plain bash builtins Toolkit to create simple Terminal UIs using plain bash builtins
> Tested with Ubuntu, Alpine, Debian.
>
> MacOS currently broken with iTerm 2 -> working on it
## Goals ## Goals
- provide a simple and clear default set of elements to use creating an interactive terminal UI - provide a simple and clear default set of elements to use creating an interactive terminal UI
- be clean and minimalistic - be clean and minimalistic
@@ -17,11 +13,19 @@ Toolkit to create simple Terminal UIs using plain bash builtins
- parts can be used separately - parts can be used separately
## Install ## Install
> tbd 1. Download the bundle (entire lib) or single compoennt from [releases](https://github.com/timo-reymann/bash-tui-toolkit/releases)
2. Source the bundle in your script or embed
## Documentation ## Documentation
For a list of available modules and their documentation please check the [docs/modules](./docs/modules) folder For a list of available modules and their documentation please check the [docs/modules](./docs/modules) folder
## Tested with
- Ubuntu 20
- Ubuntu 22
- Alpine 3
- MacOS
- Windows (Git Bash)
## Development ## Development
### Requirements ### Requirements