From 3f57855f6b2154f3d7ec516e08a23c1343479df6 Mon Sep 17 00:00:00 2001 From: Timo Reymann Date: Fri, 3 Jan 2025 15:20:51 +0100 Subject: [PATCH] docs: Add docs structure --- README.md | 2 +- docs/{Compability.md => Compatibility.md} | 0 docs/index.md | 13 +++++++++++++ 3 files changed, 14 insertions(+), 1 deletion(-) rename docs/{Compability.md => Compatibility.md} (100%) create mode 100644 docs/index.md diff --git a/README.md b/README.md index 5e0c36d..bc6092b 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ the target system. ## Documentation - [Modules](./docs/modules) - Modules available and their usage -- [Compability table](./docs/Compability.md) - Known combinations of OS/Bash Version/Terminal emulators that work guaranteed +- [Compability table](./docs/Compatibility) - Known combinations of OS/Bash Version/Terminal emulators that work guaranteed ## Contributing diff --git a/docs/Compability.md b/docs/Compatibility.md similarity index 100% rename from docs/Compability.md rename to docs/Compatibility.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..5dee5d3 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,13 @@ +bash-tui-toolkit +=== + +Toolkit to create interactive and shiny terminal UIs using plain bash builtins + +## Contents + +- [Compatibility](./Compatibility) +- Available Modules + - [Logging](./modules/Logging.md) + - [Platform Helpers](./modules/Platform-Helpers.md) + - [Prompts](./modules/Prompts.md) + - [User Feedback](./modules/User-Feedback.md) \ No newline at end of file