Skip to content

Commit 58ef43d

Browse files
Add app README inside sample_editor/
Moves the original Sample Text Editor README (run instructions, author, GPL icon license) next to app.py, where its relative paths resolve. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 5937d6a commit 58ef43d

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Sample Text Editor
2+
3+
A **sample text editor** that shows how to use Qt Designer to create GUI applications.
4+
5+
## How to Run this Application
6+
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:
8+
9+
```sh
10+
$ python3 -m venv ./venv
11+
$ source venv/bin/activate
12+
(venv) $ pip install PyQt6
13+
```
14+
15+
Once you have [PyQt](https://www.riverbankcomputing.com/static/Docs/PyQt6/) installed, you can run the application by executing the following command:
16+
17+
```sh
18+
(venv) $ python app.py
19+
```
20+
21+
This command will launch the application, so you'll be able to experiment with it.
22+
23+
## About the Author
24+
25+
Leodanis Pozo Ramos – [@lpozo78](https://twitter.com/lpozo78)lpozor78@gmail.com
26+
27+
## License
28+
29+
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.

0 commit comments

Comments
 (0)