diff --git a/README.md b/README.md index ebb5f34..1580375 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,21 @@ A simple game which takes an image, then slices it into tiles and shuffles. You ### How to build You only need a compiler supporting c++17 and sfml 2.5.1 (or latter versions). +First of all, clone the project and go to the project folder +``` +git clone https://dev.udongein.xyz/NaiJi/sliding-puzzle +cd sliding-puzzle/ +``` + +Then simply build it with CMake +``` +cmake CMakeLists.txt -B ../sliding-puzzle-build +cd ../sliding-puzzle-build +make +``` + ### Usage +Run it from terminal, providing optional flags and filepath. Move cursor by either WASD or arrows. Press Z to select a tile and then select a direction to swap the tile with a neighbor from that direction. Repeat until the inital image gets completely assembled! ``` usage: sliding-puzzle [-OPTIONS...] FILE-OR-DIRECTORY