Skip to content

Commit bb49c6b

Browse files
Add basic Setup section.
1 parent e2501aa commit bb49c6b

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ your Qt applications.
6969

7070
# Code Overview
7171

72+
You can browse the source code files above, or clone the repository
73+
to download and run them yourself. See the Setup section if you need
74+
more details.
75+
7276
## `app_simple_*.py` examples
7377

7478
<img width="984" alt="image" src="https://user-images.githubusercontent.com/104786633/206917691-29d444a6-0c43-4ac6-b837-2ad4c53459e9.png">
@@ -112,8 +116,40 @@ This module displays a list of people (Person objects) with
112116
a variety of attributes, with different types, each of which can
113117
be edited.
114118

119+
# Setup
120+
121+
*Full coverage of install/setup issues is not practical here, but this should
122+
cover the basics*
123+
124+
As noted above, you can browse the source code files on github, or clone
125+
the repository to download and run them yourself.
126+
127+
You'll need to [install Python](https://www.python.org/downloads/)
128+
(or [install Miniconda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation),
129+
Anaconda is not compatible with PySide6 as of this writing),
130+
download one of the Qt libraries, and clone or download this repository
131+
to run the examples yourself.
132+
133+
To run each of the different demo modules, just `python app_table_people.py`
134+
(`python` followed by the name of the py file you want to run).
135+
136+
## Regular Python Setup
137+
138+
Once you've installed Python, you can run `pip install PySide6` to install Qt.
139+
If you see an error about the command not being found, you'll need to fix your
140+
`PATH` environment variable (if install succeeded, you may just need to close and
141+
reopen your terminal), or specify the full path to pip (not preferable).
142+
143+
## Miniconda Setup
144+
145+
Once you've installed Miniconda, you can `conda create -n appdemos pip` to
146+
create an environment with pip, `conda activate appdemos` to activate it, then
147+
`pip install PySide6` to install Qt. If you see an error about the command not
148+
being found, you'll need to fix your `PATH` environment variable (if install
149+
succeeded, you may just need to close and reopen your terminal), or specify
150+
the full path to the conda executable (not preferable).
151+
115152
# Final Thoughts
116153

117154
Submit an issue to the repo if you want to suggest a change or have
118-
a question. If it fits with the project, odds are good it'll be
119-
added in the future.
155+
a question or bug report.

0 commit comments

Comments
 (0)