Skip to content

Commit c4048dd

Browse files
committed
docs: improve introduction
1 parent b884d72 commit c4048dd

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# Python, now with 39% more GUI 🐍💻
22

3-
Template for pythons apps with GUI. Features automated builds on release with binaries for Windows, MacOS and Linux users to download.
3+
Template for pythons apps with a GUI. Features automated builds on release with binaries for Windows, MacOS and Linux users to download.
44
Contains linting, formatting and testing tools.
55

6+
Although this template is meant to be a base for bigger projects, there are some limitations and annoyances that derive from using python bindings with Qt. To name a few, testing can be cumbersome with PyTest-Qt and the API is not always easy to work with or well documented. Other than that, there is also no tooling for using Qt translations with ease so this template essencially provides a non-localized app, this is not to say that it can't be added when building upon it.
7+
8+
With the exception of the points above, we believe this template to be decently production ready.
9+
610
## Requirements 📋
711

812
- Python 3.12.0+
@@ -55,7 +59,7 @@ Contains linting, formatting and testing tools.
5559
ruff format
5660
```
5761

58-
- PyTest andPyTest-QT are used for testing:
62+
- PyTest and PyTest-Qt are used for testing:
5963

6064
```shell
6165
pip install .[test]

0 commit comments

Comments
 (0)