You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,14 @@ Two variants are available:
6
6
-**[`miniterm`](miniterm/README.md)** — legacy implementation, works with Java 8+
7
7
-**[`miniterm-ffm`](miniterm-ffm/README.md)** — modern implementation using the Foreign Function & Memory API, requires Java 22+
8
8
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"):
**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
-
17
17
**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).
18
18
19
19
## Usage
@@ -154,6 +154,8 @@ examples\run-ffm.bat
154
154
The scripts will list the available examples and let you choose one to run:
155
155
156
156
-**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
157
159
-**PrintKeys** — prints the code of each key pressed
158
160
-**PrintMouse** — prints mouse events
159
161
-**PrintSize** — prints the current terminal dimensions
0 commit comments