From da8a756c50629cce4d6f980790036620a8dd6ceb Mon Sep 17 00:00:00 2001 From: Francesco Luzzana Date: Tue, 1 Mar 2022 22:15:52 +0100 Subject: [PATCH] updated readme --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cd9e965..9b72ce6 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ The idea is to have several puzzles and mix their pieces, in a way that invites This prototype covers two aspects of the process: the first is to split an image into pieces, tracking every piece with an ID and store the relation between adjacent tiles. The second concerns the online platform, and it is a Flask application that permits to upload cluster of pieces in order to share them with the other players and unlocking the full puzzle. -To install the project: +## To install the project: 1. Clone the repo 2. Create a virtual environment @@ -28,6 +28,8 @@ To install the project: ``` 6. The Flask application will be accessible on your browser at `localhost:5000`. If you try to navigate there you will see a blank page. This is because we need to generate some puzzles to display. +## Generating the contents + The first thing to do then is to run the `split.py` script: ``` @@ -38,6 +40,8 @@ This will take the Katamari demo picture from `static/img` and will split it in You can tweak the parameters at the end of the split.py file. This is temporary, later on it would be nice to have an interface to prepare the puzzle. +## Completing the puzzles + If you reload the website, you will see a link pointing to the Katamari page. Here we will find an empty frame, and a form to insert new pieces. Try it! You can find the IDs for the pieces in the `chaospuzzles/puzzles/katamari/katamari_retro.png` image. This is the picture generated in order to be printed behind the puzzle and let every piece to have a unique ID.