Add comprehensive documentation for terminal-ui

- Introduced new documentation files: `Components.md`, `Examples.md`, `Home.md`, `Install.md`, and `index.md`.
- Provided detailed guides on usage, examples, installation, and API components.
- Linked GitHub Pages and repository resources for easy navigation.
This commit is contained in:
!verity
2026-03-14 10:09:33 +01:00
parent 34b683aacf
commit 97a43d9850
5 changed files with 405 additions and 0 deletions

25
docs/Home.md Normal file
View File

@@ -0,0 +1,25 @@
# terminal-ui
Java library for building terminal UIs: tables, rules, colors, prompts, menus, SelectList, pager, and more. Fluent API, ANSI support, testable.
## Quick links
- **[Install](Install)** Gradle / Maven dependency
- **[Components](Components)** What's in the library
- **[Examples](Examples)** Code snippets
## Requirements
- Java 21
- Gradle 9.x or Maven (wrapper included in repo)
## Build from source
```bash
./gradlew build
./gradlew test
```
## License
MIT see [LICENSE](https://github.com/jakubbbdev/terminal-ui/blob/master/LICENSE) in the repo.