Skip to content

Commit ab9a395

Browse files
committed
more running instructions.
1 parent f0621d0 commit ab9a395

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ you'll need to install tkinter for your platform
2323
3. Download/clone this git repository
2424
4. install the required packages: *pip install -r requirements.txt*
2525

26-
note 1: I have not tested the install on other systems. Let me know if there's an issue:
26+
note 1: I have not tested the install on other systems. Let me know if there's an issue.
27+
2728
note 2: It is better form to put it in it's own virtual environment. See various web tutorials on how to do that.
2829

2930
## Running the code
@@ -32,7 +33,18 @@ The easiest with to run the program is to use the GUI:
3233

3334
![GUI](images/gui.png)
3435

35-
python rt_gui.py
36+
type: *python rt_gui.py*
37+
38+
Then Click on the *start* button to start the rendering. The image will be saved in the current working directory
39+
as *rt.png* (unless changed by the IMAGE_FILENAME environment variable.)
40+
41+
note: There are a lot of features that could be added to the GUI. Top of the list is to set the scene file from a
42+
command line option or menu item. For now it is hard-coded in the code. To change the scene, set the
43+
CREATOR_FUNC variable:
44+
45+
CREATOR_FUNC = create_canonical_1
46+
47+
There are several sample scene files in *create_scene_funcs.py*.
3648

3749
The program can be run from the command line with:
3850

0 commit comments

Comments
 (0)