Browse Source

Added more info in the README

pull/199/head
Eugenio Parodi 2 years ago
parent
commit
8e04d3ace9
  1. 11
      README.md

11
README.md

@ -19,12 +19,14 @@ and inspired by a mix of [Qt5](https://www.riverbankcomputing.com/static/Docs/Py
[pyTermTk.Showcase.002.webm](https://user-images.githubusercontent.com/8876552/206490679-2bbdc909-c9bc-41c1-9a50-339b06dabecd.webm) [pyTermTk.Showcase.002.webm](https://user-images.githubusercontent.com/8876552/206490679-2bbdc909-c9bc-41c1-9a50-339b06dabecd.webm)
## Features ## Features
- Cross compatible: Linux, Mac, MS Windows, HTML5 - Self Contained (no external lib required)
- Cross compatible: [Linux](https://en.wikipedia.org/wiki/Linux), [MacOS](https://en.wikipedia.org/wiki/MacOS), [MS Windows](https://en.wikipedia.org/wiki/Microsoft_Windows), [HTML5](https://en.wikipedia.org/wiki/HTML5)
- Basic widgets for [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface) development (Button, Label, checkbox, ...) - Basic widgets for [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface) development (Button, Label, checkbox, ...)
- Specialized widgets to improve the usability (Windows, Frames, Tables, ...) - Specialized widgets to improve the usability (Windows, Frames, Tables, ...)
- QT Like Layout system to help arrange the widgets in the terminal - QT Like Layout system to help arrange the widgets in the terminal
- True color support - True color support
- Ful/Half/Zero sized Unicode characters 😎 - Ful/Half/Zero sized Unicode characters 😎
- I am pretty sure there is something else...
## Limitations ## Limitations
- Only the key combinations forwarded by the terminal emulator used are detected (ALT,CTRL may not be handled) - Only the key combinations forwarded by the terminal emulator used are detected (ALT,CTRL may not be handled)
@ -70,13 +72,14 @@ python3 tests/test.input.py
#### Demos #### Demos
```bash ```bash
# Press CTRL-C to exit # Press CTRL-C to exit (CTRL-Break on Windows)
# the logs are written to "session.log"
# add "-f" option to run it in "fullscreen" :-D
# Showcase Demo # Showcase Demo
python3 demo/demo.py -f python3 demo/demo.py -f
# run the ttkDesigner
python3 -m ttkDesigner
# Paint demo # Paint demo
python3 demo/paint.py python3 demo/paint.py

Loading…
Cancel
Save