Skip to content

Commit 0ee4aed

Browse files
authored
Update README.md
1 parent 0ff29eb commit 0ee4aed

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,41 @@
11
# pyqt-transparent-timer
22
PyQt transparent timer
3+
4+
## Requirements
5+
PyQt5 >= 5.8
6+
7+
## Setup
8+
```pip3 install git+https://github.com/yjg30737/pyqt-transparent-timer.git --upgrade```
9+
10+
## Included Packages
11+
* <a href="https://github.com/yjg30737/pyqt-notifier.git">pyqt-notifier</a>
12+
* <a href="https://github.com/yjg30737/pyqt-resource-helper.git">pyqt-resource-helper</a>
13+
14+
## Example
15+
Code Sample
16+
```python
17+
from PyQt5.QtWidgets import QApplication
18+
from pyqt_transparent_timer import TransparentTimer
19+
20+
21+
if __name__ == "__main__":
22+
import sys
23+
24+
app = QApplication(sys.argv)
25+
tm = TransparentTimer()
26+
tm.show()
27+
app.exec_()
28+
```
29+
30+
Result
31+
32+
![image](https://user-images.githubusercontent.com/55078043/149067604-650f7927-5470-44a2-b505-c863e28d8237.png)
33+
34+
When mouse cursor is hovering over the widget, border and background will show up.
35+
36+
![image](https://user-images.githubusercontent.com/55078043/149068105-d399fa18-1e48-4556-9d29-90c4f7a3e53e.png)
37+
38+
Except for graphics, this module operates the same way as pyqt-timer.
39+
40+
## See also
41+
<a href="https://github.com/yjg30737/pyqt-timer.git">pyqt-timer</a>

0 commit comments

Comments
 (0)