Skip to content

Commit

Permalink
🎨 updaet notebook and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasParistech committed Jun 5, 2024
1 parent 27b9322 commit 7b3b31c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 5 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
[Link to the Medium article](https://medium.com/better-programming/generate-and-print-your-custom-dobble-274dc888a33e)
# Medium Article

For a detailed explanation of the algorithm used, please refer to my [`Medium article`](https://medium.com/better-programming/generate-and-print-your-custom-dobble-274dc888a33e) where I explain the different steps of the algorithm.



# Google Colab Notebook

If you'd like to avoid the hassle of setting up your Python environment, you can effortlessly use this dedicated [`Google Colab notebook`](./colab_notebook.ipynb).

Simply run it on [`Google Colab`](https://colab.research.google.com/).



# Local Run

Run
```
python3 -m dobble --symbols_folder <SYMBOL_FOLDER> --output_folder <RESULT_FOLDER>
```
to execute the 4 following steps:
- Make all images square and rotation-proof
- Extract the binary mask of the symbols images
to execute the 3 following steps:
- Make all images square and rotation-proof and extract their binary masks
- Generate 57 cards with randomly drawn symbols
- Merge Dobble cards into a scaled PDF ready to print

Expand All @@ -15,4 +28,8 @@ To try on toy data, run
python3 -m dobble --symbols_folder images/symbols_examples/ --output_folder result
```


# Example
![](./images/dobble_evolution.gif)


2 changes: 1 addition & 1 deletion colab_notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
},
"outputs": [],
"source": [
"!git clone https://github.com/ThomasParistech/dobble.git"
"!git clone --depth 1 --branch v1.2.0 https://github.com/ThomasParistech/dobble.git"
]
},
{
Expand Down

0 comments on commit 7b3b31c

Please sign in to comment.