Update --help and add README
parent
37485820a4
commit
90ed819f17
@ -0,0 +1,23 @@
|
||||
# sliding-puzzle
|
||||
A simple game which takes an image, then slices it into tiles and shuffles. You need to restore the initial image by swapping neighbor tiles! It's a command line application and does support --help.
|
||||
|
||||
### How to build
|
||||
You only need a compiler supporting c++17 and sfml 2.5.1 (or latter versions).
|
||||
|
||||
### Usage
|
||||
usage: sliding-puzzle [-OPTIONS...] FILE-OR-DIRECTORY
|
||||
|
||||
Provide FILE-OR-DIRECTORY variable as a path to either a directory
|
||||
which contains images (one will be picked randomly) or a specific
|
||||
image file of .bmp, .jpg, of .png format.
|
||||
|
||||
If no path was provided, it will be assumed as '.'!
|
||||
|
||||
Options:
|
||||
[-r NUMxNUM] Provide it if you want to explicitly define
|
||||
window resolution.
|
||||
[-s NUM] Provide it if you want to explicitly define
|
||||
qualifier for image slicing, it's counted
|
||||
by the smallest side of given source texture.
|
||||
Hence, if your image is square, the amount of tiles
|
||||
will be num * num.
|
Loading…
Reference in New Issue