Skip to content

Commit 7027ea7

Browse files
committed
Improve project information
1 parent 5038933 commit 7027ea7

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

SudokuSolver/README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,27 @@
11
# Sudoku Solver
22
## Description
3-
A minimalist Python application which solves a given Sudoku problem in a **.txt file** following certain *formatting rules*.
3+
A minimalist Python application which solves a given Sudoku problem in a *.csv file* following certain *formatting rules*.
44

55
### Formatting rules for .txt Sudokus
6+
- The **first row** of the *.csv file* must be the following: `a,b,c,d,e,f,g,h`.
7+
- The following rows will be the **numbers** of the sudoku given. The number **zero (0)** represents an empty cell or *naked cell*.
8+
- The numbers will be separatted by commas, formatting the **columns**.
9+
- Example of *.csv file* can be found under the folder **examples**.
610

711
## Requirements
812

13+
This projects uses the following external libraries:
14+
- **NumPy**
15+
- **Pandas**
16+
17+
To be able to run this project, execute: `pip install -r requirements.txt`
18+
919
## Steps To Execution
1020

11-
## Samples
21+
- Under the folder *SudokuSolver*, run: `python3 main.py`
22+
- The path for a *.csv file* following the above formatting rules will be required. **YOU SHOULDN'T TYPE THE .CSV EXTENSION ALONG THE NAME OF THE FILE**.
23+
- Example of input: **examples/ex2**
24+
25+
## TODOS
26+
- Implement a simple **GUI** by using *tkinter* library.
27+
- In the above mentioned **GUI**, implement an speed regulator to be able to see how the algorithm tests, fails, and backtracks.

0 commit comments

Comments
 (0)