Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md file #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 58 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,69 @@
# Sudoku-GUI-Solver
This is a sudoku solver using the backtracking algorithm. It includes a graphical GUI as well as a text based version.
# Project Title:

Run GUI.py to play sudoku.
A Sudoku GUI solver using the Backtracking Algorithm.

# Instructions
Click a box and hit the number on your keybaord to pencil in a number. To confirm that value press the ENTER key on that box. To delete a pencil in you can click DEL. Finally to solve the board press SPACE, sit back and watch the algorithm run.
## 1. Project Description:

# Video Tutorial
This Sudoku solver tutorial uses Python programming language and the backtracking algorithm to find a solution to any solvable sudoku board.

You can view the video tutorials on how to create this project here: https://www.youtube.com/watch?v=eqUwSA0xI-s&t=871s
[Backtracking](https://pythonwife.com/backtracking-in-python/) is simply reverting back to the previous step or solution as soon as we determine that our current solution cannot be continued into a complete one.

# Run in Gitpod
## 2. Languages Used:

* [Python](https://www.python.org/)

## 3. Installing:

i. Clone the git repo

```
https://github.com/techwithtim/Sudoku-GUI-Solver.git
```

ii. Open project folder

iii. Explore

iv. Open GUI.py and run

v. Play the Sudoku game

Enjoy 😎

## 4. Run in Gitpod:

You can also run Sudoku-GUI-Solver in Gitpod, a free online dev environment for GitHub:

If you're intersted in a paid subscription with GitPod use the coupon code: TECHWITHTIM19

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/techwithtim/Sudoku-GUI-Solver/blob/master/GUI.py)


## 5. How to play:

Click a box and hit the number on your keybaord to pencil in a number.

To confirm that value press the ENTER key on that box.

To delete a pencil in you can click DEL.

Finally to solve the board press SPACE, sit back and watch the algorithm run.

## 6. Contributing:

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change with "Tim Ruscica" (Project Owner).

## 7. Original Creator:

Author: Tim Ruscica

Project Name: Sudoku-GUI-Solver

Tim Ruscica URL: https://www.techwithtim.net/tutorials/python-programming/sudoku-solver-backtracking/

Youtube URL: https://www.youtube.com/watch?v=eqUwSA0xI-s&t=871s

Github URL: https://github.com/techwithtim/Sudoku-GUI-Solver

Date: 2 April, 2019