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:
25
docs/Home.md
Normal file
25
docs/Home.md
Normal 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.
|
||||
Reference in New Issue
Block a user