Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
perspector authored Dec 15, 2022
1 parent 3782b8d commit 1f08e58
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,28 @@
# PyCornhole
This is a corn hole scoreboard that uses python3.8 and tkinter to display your scores!
This is a corn hole scoreboard that uses Python 3 and a tkinter GUI to display your scores!
<img src="https://raw.githubusercontent.com/BennyThePythonCoder/PyCornhole/master/cornHole.png" align="right" width="250px" height="200px"/>
## Installing
There are two options for installing:
### 1. Terminal
Open your terminal and type: `git clone https://github.com/perspector/PyCornhole.git`
Open your terminal and type:\
`git clone https://github.com/perspector/PyCornhole.git`

It should go into your /Downloads folder.
It should go into the folder you ran the command in.

### 2. Downloading the ZIP file
You can download the .zip file by pressing "download as ZIP" in the repository.
You can download the .zip file by pressing "download as ZIP" in the repository.\
The .zip file should go into your /Downloads folder.

## Running
Just double click *CornHole.py*, it should be an excecutable python script.
If that doesn't work, open *CornHole.py* in your python editor, and run it. [Geany](https://www.geany.org/) or [Thonny](https://thonny.org/) are recommended but not required. **Also make sure you have [Python 3](https://python.org) installed.**
### Option 1: Run the Python Program Through Your File Manager
Just double click *CornHole.py*, it should be an excecutable python script.\
If that doesn't work, open *CornHole.py* in your python editor, and run it. [Geany](https://www.geany.org/) or [Thonny](https://thonny.org/) are recommended but not required. **Also make sure you have [Python 3](https://www.python.org/downloads/) installed.**
### Option 2: Run from the Command Line
Just go into the folder you installed PyCornhole into, and type the following commands:\
`cd PyCornhole`\
`python3 CornHole.py`

I made it so it automatically installs all dependencies. **_Please make sure you have an internet connection the first time you run the program!_**

I hope you like the program! If you have any questions or problems, please [post an issue](https://github.com/BennyThePythonCoder/PyCornhole/issues) in this repository.
I made the program so it automatically installs all dependencies. **_Please make sure you have an internet connection the first time you run the program!_**

I hope you like the program! If you have any questions or problems, please [create an issue](https://github.com/BennyThePythonCoder/PyCornhole/issues) in this repository.

0 comments on commit 1f08e58

Please sign in to comment.