back to scratko.xyz
aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 42 insertions, 1 deletions
diff --git a/README.md b/README.md
index 76bbeb7..1e87112 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,43 @@
-<a href="https://scratko.xyz/games/puzzle.exe" target="_blank">Download Windows
+# Picture puzzle
+
+<img src="puzzle.png" />
+
+A desktop game similar to the standard widget in windows 7. The game is written
+in C++ (including C++17 standard). FLTK was used as a graphics library. This
+library is not as heavy as Qt, and allows to quickly create an application with
+graphical widgets.
+
+The essence of the game should be clear: to collect the image in its original
+form, moving one puzzle per move.
+
+The application has the following features:
+
+- *upload your image in any format and resolution. The program itself will
+ resize, cut into puzzles, create the appropriate directory and save them in
+ it.*
+
+- *showing the complete solution of the puzzle using the optimization algorithm
+ A\*.*
+
+- *the game is distributed in a single executable file by embedding the original
+ standard image (toucan image) in the executable file. The image data is stored
+ in an array in an object file (resources.o)*
+
+- *support for \*unix and Windows platforms*
+
+## Building
+
+For \*nix platform, you need to install FLTK library and then do the following:
+
+```
+git clone https://git.scratko.xyz/picture-puzzle
+cd picture-puzzle
+make
+./main
+```
+
+## For Windows platform
+
+The built executable file (under x86_64) is available at the link: <a
+href="https://scratko.xyz/games/puzzle.exe" target="_blank">Download Windows
version</a>