Skip to content

Commit 75d0511

Browse files
authored
Update README.md with promo images and .exe info
1 parent d7a7b77 commit 75d0511

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# racket-sudoku
1+
# Smooth Sudoku
22
Playable sudoku client written as a HtDW world program in Racket ISL
33

44
--------------------------------------------------------------------------------
@@ -17,18 +17,34 @@ algorithm using constraint sets. Redesigning the data types and functions this
1717
way allowed the new algorithm to become much more efficient.
1818

1919
3. For this current project after term ended, I designed and built a fully
20-
playable sudoku game GUI that employs the constraint set solver algorithm. My
21-
full game includes several features that make use of the algorithm's constraint
22-
sets (e.g. autosolve mode, hint system, error tracking, option display...)
20+
playable sudoku game GUI that employs multiple variations on the constraint
21+
set solver algorithm. My full game includes several features that make use of
22+
the algorithm's constraint sets (e.g. autosolve mode, hint system, error
23+
tracking, option display...)
24+
25+
## Features
26+
27+
<img src="/promo/image-new-hover-mouse.png" alt="Smooth Sudoku interface: new game and hover-to-play" title="New game" width="500"/>
28+
29+
<img src="/promo/image-errors-undo.png" alt="Smooth Sudoku features: show errors and undo" title="Undo/Show Errors" width="500"/>
30+
31+
<img src="/promo/image-hint-choices.png" alt="Smooth Sudoku interface: hints and show choices" title="Hint/Show Choices" width="500"/>
32+
33+
<img src="/promo/image-winner.png" alt="Smooth Sudoku interface: autosolve and win screen" title="Autosolve" width="500"/>
34+
2335

2436
## User Information
2537
### COMPATIBILITY
26-
- DrRacket 8.1;
38+
#### To run from source code:
39+
- DrRacket 8.1+;
2740
- Language: Intermediate Student with lambda
2841

29-
### INSTALLATION
30-
- [Install the latest version of DrRacket.](https://racket-lang.org/)
31-
- Use menu `Language` -> `Choose Language...` and select "Intermediate Student with lambda".
42+
_**HOW TO INSTALL:**_ Install the latest version of [DrRacket.](https://racket-lang.org/). Download and open the [`play.racket.rkt`](/play-sudoku.rkt) source file in DrRacket, then run the program using the DrRacket IDE.
43+
44+
#### To run .exe release file:
45+
- Windows 10+
46+
47+
_**HOW TO INSTALL:**_ Download the latest .exe release from [this repo folder](/play-sudoku/), then run the application.
3248

3349
### USING THE PROGRAM
34-
- Run the program; the game interface window will appear. Interact with it using the mouse.
50+
- On running the program, the game interface window will appear. Interact with it using the mouse.

0 commit comments

Comments
 (0)