Skip to content

Commit c8fb5bb

Browse files
committed
📝 added goal, qt creator and stylesheets to readme
1 parent 1f3ec98 commit c8fb5bb

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Qt for Python Project Template
22

3-
A model-view-controller (MVC) project template built around Qt for Python.
3+
This is a model-view-controller (MVC) project template built around Qt for Python.
4+
5+
The goal is to create a design pattern which leverages the usability of Qt Creator while spending as little time as possible with Qt itself.
46

57
## Requirements
68

@@ -16,7 +18,22 @@ This project was developed and tested with the following, more specific versions
1618
- Python 3.8.1
1719
- packages listed in `requirements.txt.lock`
1820

21+
## Qt Creator Integration
22+
23+
`MainWindow` can be opened in Qt Creator and edited via the included `qtcreator.pro` project file.
24+
25+
More information on Qt Creator can be found here:
26+
27+
[Getting Started | Qt Creator Manual](https://doc.qt.io/qtcreator/creator-getting-started.html)
28+
29+
To apply any changes, re-run `scripts/update-ui`. The updated `src/widgets/ui_mainwindow.py` file should be committed along with the updated `qtcreator/mainwindow.ui` file.
30+
31+
### StyleSheet
32+
33+
The Qt StyleSheet located at `src/widgets/stylesheet.css` gets loaded into MainWindow at runtime.
34+
35+
The practical effect of this is that the current styles are not reflected in the project in Qt Creator. As a work-around, to see them in Qt Creator, copy-paste the contents of the file into the widget property directly.
1936

2037
## scripts
2138

22-
There are bash scripts located in the `scripts` dir. They should be simple enough that, even if you are in windows, you should be able to use it as a guide to performing the task.
39+
There are bash scripts located in the `scripts` dir. They should be simple enough that, even if you are in windows, you can use them as a guide to performing the task at hand.

0 commit comments

Comments
 (0)