From 0a79553f32b2d3724db1bddd00c035da98e72f7c Mon Sep 17 00:00:00 2001 From: Tojaw <41524896+Tojaw@users.noreply.github.com> Date: Sun, 2 Apr 2023 15:39:41 +0200 Subject: [PATCH] Executing instructions added to README I added some basic instructions on how to run the program to the README.md. It just covers the basics, but especially for Windows users who don't know how to run a Python script it should suffice. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 5653465..79285b5 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,16 @@ Other Linux distributions can download the source code. The program needs Python Download the source code and install python3.6 or greater. Make sure to install Tk/Tcl with it. +### Running the program + +Open a terminal window and navigate to the `src` directory. On Windows this can be easily done by pressing `Shift` and right-clicking on empty space within that directory. Click on the context menu entry "Open in Terminal" or "Open PowerShell window here". If it doesn't show up, try again first, sometimes it simply doesn't work the first time. + +Now start the program: + + python main.py + +A bunch of text should appear within that terminal window and after a short while, another window with the program should open. If you want to report a bug, please make sure to copy-paste the entire content of the terminal window. + --- ## How does it work?