Skip to content

Commit de7afdd

Browse files
committed
docs: minor README update
1 parent dbdbce4 commit de7afdd

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Two variants are available:
66
- **[`miniterm`](miniterm/README.md)** — legacy implementation, works with Java 8+
77
- **[`miniterm-ffm`](miniterm-ffm/README.md)** — modern implementation using the Foreign Function & Memory API, requires Java 22+
88

9-
And then we have utility modules:
9+
**Philosophy** : these modules, and the project in general, have been expressly created to be as minimal as possible, it only offers the most essential functionality that is missing from Java to be able to use the features of a modern Terminal. Several other projects exist that do this as well, but they normally come with a whole bunch of other things that you might not need. `miniterm` on the other hand *only* does the work that you can't do with standard Java APIs. Everything else can be built on top.
10+
11+
And then we have utility modules (the "built on top"):
1012
- **[`ansiparser`](ansiparser/README.md)** — compact ANSI escape sequence parser
1113
- **[`colors`](colors/README.md)** — terminal colour palette querying and setting
1214
- **[`mousetrack`](mousetrack/README.md)** — terminal mouse-tracking helpers and event parser
1315
- **[`termcap`](termcap/README.md)** — terminal capability detection
1416

15-
**Philosophy** : this project has been expressly created to be as minimal as possible, it only offers the most essential functionality that is missing from Java to be able to use the features of a modern Terminal. Several other projects exist that do this as well, but they normally come with a whole bunch of other things that you might not need. `miniterm` on the other hand *only* does the work that you can't do with standard Java APIs. Everything else can be built on top.
16-
1717
**Acknowledgements** : `miniterm` is inspired by and has unashamedly copied ideas and code from [AEsh](https://github.com/aeshell/aesh-readline) and [Tamboui Panama backend](https://github.com/tamboui/tamboui/tree/main/tamboui-panama-backend).
1818

1919
## Usage
@@ -154,6 +154,8 @@ examples\run-ffm.bat
154154
The scripts will list the available examples and let you choose one to run:
155155

156156
- **PrintAnsi** — prints the the ANSI sequence of each key pressed
157+
- **PrintCaps** — prints the capabilities that the terminal supports
158+
- **PrintColors** — detects and prints the colors that the terminal supports
157159
- **PrintKeys** — prints the code of each key pressed
158160
- **PrintMouse** — prints mouse events
159161
- **PrintSize** — prints the current terminal dimensions

0 commit comments

Comments
 (0)