Skip to content

Commit dfbd4ef

Browse files
Restructure qt-designer-python README to the standard materials format
Lead with the post-materials header (normalized title + published tutorial link), then keep the app-specific run instructions and the GPL icon-license note. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 5513b4e commit dfbd4ef

1 file changed

Lines changed: 8 additions & 12 deletions

File tree

qt-designer-python/README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
1-
# Sample Text Editor
1+
# Qt Designer and Python: Build Your GUI Applications Faster
22

3-
A **sample text editor** that shows how to use Qt Designer to create GUI applications.
3+
This folder provides the code examples for the Real Python tutorial [Qt Designer and Python: Build Your GUI Applications Faster](https://realpython.com/qt-designer-python/)
44

5-
## How to Run this Application
5+
## How to Run This Application
66

7-
To run this application, you need to [install `PyQt6`](https://realpython.com/python-pyqt-gui-calculator/#installing-pyqt) on your Python environment. To do that, you can run the following commands in a terminal or command prompt:
7+
Create and activate a Python virtual environment, then install [PyQt6](https://pypi.org/project/PyQt6/):
88

99
```sh
1010
$ python3 -m venv ./venv
1111
$ source venv/bin/activate
12-
(venv) $ pip install PyQt6
12+
(venv) $ python -m pip install pyqt6
1313
```
1414

15-
Once you have [PyQt](https://www.riverbankcomputing.com/static/Docs/PyQt6/) installed, you can run the application by executing the following command:
15+
Then launch the sample text editor from the `sample_editor/` directory:
1616

1717
```sh
1818
(venv) $ cd sample_editor/
1919
(venv) $ python app.py
2020
```
2121

22-
This command will launch the application, so you'll be able to experiment with it.
23-
24-
## About the Author
25-
26-
Leodanis Pozo Ramos – [@lpozo78](https://twitter.com/lpozo78)lpozor78@gmail.com
22+
Run `app.py` from inside `sample_editor/`, because the application loads its `.ui` files and icons through relative paths.
2723

2824
## License
2925

30-
The set of icons used in this application are part of the [TurkinOS](https://github.com/llamaret/turkinos-icon) icon theme, which is distributed under the [GPL v3.0 license](https://github.com/llamaret/turkinos-icon/blob/master/LICENSE). See `ui/resources/LICENSE` for details.
26+
The icons used in this application are part of the [TurkinOS](https://github.com/llamaret/turkinos-icon) icon theme, distributed under the [GPL v3.0 license](https://github.com/llamaret/turkinos-icon/blob/master/LICENSE). See `ui/resources/LICENSE` for details.

0 commit comments

Comments
 (0)