Skip to content

Commit

Permalink
chore: update readme with recent changes
Browse files Browse the repository at this point in the history
  • Loading branch information
TN1ck committed Aug 25, 2024
1 parent a29913e commit 44c022d
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,30 @@

Currently hosted at [https://sudoku.tn1ck.com](https://sudoku.tn1ck.com).

![Screenshot 2022-09-05 at 19 15 08](https://user-images.githubusercontent.com/2116347/188494040-0a7b4512-c5b8-4073-bc4a-b78e469ad90e.png)
![Screenshot of the sudoku app](./docs/screenshot-app-2024-08-25.png)


This project aims to be a sudoku app with everything included. An open source sudoku that is on par with all commercial applications. Why? Because my Grandma wanted to play a Sudoku once and I didn't like all the available offers. This has changed since then, but having an open source version will hopefully help people in the future.

## Features include:

- 100 sudokus for 5 different difficulties
- Save the users progress
- Generate Notes, custom notes
- Undo & hints
- Highlighting of conflicts and wrong entries
- Show occurrences of numbers in the buttons
- Shortcuts
- Arrow keys: Move around the board
- Number keys: Write a note or set the sudoku number
- Backspace: Delete a number
- Escape: Pause/unpause the game
- H: Hint
- N: Enter/exit note mode
- Undo/Redo: CMD/CTRL + Z & CMD/CTRL + Y


If something is missing, open an issue!

## Development Setup

Expand All @@ -32,22 +51,6 @@ Run the image: `docker run -p 8081:80 super-sudoku:latest` (Change 8081 for the

Automatically build images are available at [https://github.com/tn1ck/super-sudoku/pkgs/container/super-sudoku](https://github.com/tn1ck/super-sudoku/pkgs/container/super-sudoku).

## Features include:

- Solving of sudokus
- Generation of sudokus in different difficulties
- Responsive, works on desktop as well as mobile
- Providing hints to actually provide a real value over paper based sudokus
- Shortcuts
- Arrow keys: Move around the board
- Number keys: Write a note or set the sudoku number
- Backspace: Delete a number
- Escape: Pause/unpause the game
- H: Hint
- N: Enter/exit note mode
- Save the users progress
- Options to disable helper highlights like wrong entry or conflict

## Solve & Generate Sudokus

A generator was build to create an infinite amount of sudokus for every difficulty Level.
Expand Down
Binary file added docs/screenshot-app-2024-08-25.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 44c022d

Please sign in to comment.