diff --git a/README.md b/README.md index 97faf3f7..fdae5205 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,32 @@ -# pyTermTk +# [pyTermTk](https://github.com/ceccopierangiolieugenio/pyTermTk) #### Python Terminal Toolkit Text-based user interface library ([TUI](https://en.wikipedia.org/wiki/Text-based_user_interface)) Evolved from the discontinued project [pyCuT](https://github.com/ceccopierangiolieugenio/pyCuT) -and inspired by a mix of [Qt5](https://www.riverbankcomputing.com/static/Docs/PyQt5/),[GTK](https://pygobject.readthedocs.io/en/latest/) and [tkinter](https://docs.python.org/3/library/tkinter.html) api definition with a touch of personal interpretation +and inspired by a mix of [Qt5](https://www.riverbankcomputing.com/static/Docs/PyQt5/),[GTK](https://pygobject.readthedocs.io/en/latest/), and [tkinter](https://docs.python.org/3/library/tkinter.html) api definition with a touch of personal interpretation + +![](https://github.com/ceccopierangiolieugenio/binaryRepo/blob/master/pyTermTk/demo.001.gif?raw=true) ## Features -- 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, ...) -- QT Like Layout system to help arrange the widgets in the terminal -- UTF-8 and true color support +- [x] Basic widgets for [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface) development (Button, Label, checkbox, ...) +- [x] Specialized widgets to improve the usability (Windows, Frames, Tables, ...) +- [x] QT Like Layout system to help arrange the widgets in the terminal +- [ ] UTF-8 and true color support ## Limitations - Only the key combinations forwarded by the terminal emulator used are detected (ALT,CTRL may not be handled) -## Quick Test/Try +## [Tutorial](tutorial) +Be inspired by the [tutorial examples](https://github.com/ceccopierangiolieugenio/pyTermTk/tree/main/tutorial) + +## [Api Definitions](https://ceccopierangiolieugenio.github.io/pyTermTk/) +Don't get bored by the [Api Definitions](https://ceccopierangiolieugenio.github.io/pyTermTk/) + +## Install/Upgrade +[pyTermTk](https://github.com/ceccopierangiolieugenio/pyTermTk) is available on [PyPI](https://pypi.org/project/pyTermTk/) +```shell +pip3 install --upgrade pyTermTk +``` +## Quick Test/Try - no install required #### Clone ```shell @@ -36,12 +49,9 @@ python3 demo/demo.py -f # Try gittk make runGittk -# or -pip3 install GitPython -demo/gittk.py -f ``` #### Profiling -##### cProfile +##### [cProfile](https://docs.python.org/3/library/profile.html), [cProfilev](https://github.com/ymichael/cprofilev) ```shell python3 -m cProfile -o profiler.txt tests/test.ui.004.py