docs: add project overview section and fix heading levels in readme

Browse Source 
Add a "Project description" section to clarify the purpose of the sudoku generator research project, and correct inconsistent markdown heading levels (changing from `####` to `##` or `###`) for screenshots and solver subsections to improve document structure and readability.
This commit is contained in:
retoor 2025-01-10 22:43:21 +00:00
parent 3469e57f7b
commit f87a0cdc84
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,5 +1,7 @@
# Sudoku Generator # Sudoku Generator
## Project description
This project is just a collection of research regarding the generation of sudoku's. This project is just a collection of research regarding the generation of sudoku's.
It's not a production project. It's not a production project.
@ -18,17 +20,17 @@ Give sudoku puzzle as input and it will solve it for you
### Sudoku Web ### Sudoku Web
Run this server and it will run multiple sudoku generators and keeps track of many statistics while generating them. Run this server and it will run multiple sudoku generators and keeps track of many statistics while generating them.
### Screenshots ## Screenshots
Will come when I figured out how to use this project again. Will come when I figured out how to use this project again.
#### First version ### First version
![screenshot](images/sudoku1.png) ![screenshot](images/sudoku1.png)
#### Second version ### Second version
![screenshot](images/sudoku2.png) ![screenshot](images/sudoku2.png)
#### Sudoku solver. ### Sudoku solver
![screenshot](images/sudoku4.png) ![screenshot](images/sudoku4.png)
#### Last version including the web interface reachable on 9999. ### Last version including the web interface reachable on 9999
![screenshot](images/sudoku3.png) ![screenshot](images/sudoku3.png)
![screenshot](images/sudoku5.png) ![screenshot](images/sudoku5.png)