Skip to content

Commit 6553479

Browse files
committed
Add some getting started instructions to main README.md
1 parent 63191b0 commit 6553479

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,20 @@ You can also find more PyQt articles, tutorials and projects
3232
1. [Currency converter](currency/) - "Doughnut" (PyQtGraph)
3333
1. [Solitaire](solitaire/) - "Ronery" (QGraphicsScene)
3434

35+
## Getting started
36+
37+
To use each app you first need to install the requirements. In most cases
38+
the only requirements are PyQt5, and occasionally requests. To install
39+
app-specific requirements change to the folder of the app and run:
40+
41+
pip3 install -r requirements.txt
42+
43+
Once the requirements are installed, you can run the app using Python 3.
44+
45+
python3 <filename>.py
46+
47+
The application window should appear.
48+
3549
## License
3650

3751
All code is **licensed under an MIT license**. This allows you to re-use the code freely,

0 commit comments

Comments
 (0)