Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nrxss authored Mar 31, 2023
1 parent e050020 commit d26b9a1
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Perfect-Circle
Make a perfect circle on neal.fun with ~99% accuracy

### Dependencies 📚
- Python 3.x ([https://python.org](https://python.org))
- Pyautogui (To install run `pip install pyautogui` or `pip3 install pyautogui`)

### How to use 📜
- Launch a terminal and get the command to run the script ready (`python main.py` or `python3 main.py`)
- Open [https://neal.fun/perfect-circle/](https://neal.fun/perfect-circle/) in a new tab and make it fullscreen

### Troubleshooting 🛠️
#### Cannot run python or pip
- If you cannot run python or pip from a terminal, make sure to have both of them on *path*. To do that, if on Windows, search "Environment Variables" and find the PATH section. Click "Add" and paste the directory you installed Python in. (Should be "C:\Program Files\Python3\python.exe" or something similar. Make sure to include the .exe)
#### Script throws an error
- Make sure to have pyautogui installed. How to do that is mentioned on the *Dependencies* section. If you get an error while doing so, check the above troubleshooting guide.

0 comments on commit d26b9a1

Please sign in to comment.