Browse Source

improved README.md

pull/3/head
Eugenio Parodi 5 years ago
parent
commit
52436299c5
  1. 13
      README.md

13
README.md

@ -4,6 +4,15 @@ Text-based user interface library ([TUI](https://en.wikipedia.org/wiki/Text-base
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
## 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
## Limitations
- Only the key combinations forwarded by the terminal emulator used are detected (ALT,CTRL may not be handled)
## Quick Test/Try
#### Clone
@ -24,6 +33,10 @@ python3 tests/test.input.py
python3 tests/test.ui.002.py
python3 tests/test.ui.003.layout.py
python3 tests/test.ui.004.windowspy
# Try gittk
pip3 install GitPython
tests/gittk.py
```
#### Profiling
##### cProfile

Loading…
Cancel
Save