From 3598913cf3c70b70bc9c526f861f0a229e3090a3 Mon Sep 17 00:00:00 2001
From: Jeroen Overschie <jeroenoverschie@gmail.com>
Date: Sun, 3 Apr 2022 19:00:30 +0200
Subject: [PATCH] Restructure README, clarify some stuff

---
 README.md                                     | 40 ++++++++++++-------
 ...ing_competition.ipynb => quick_start.ipynb |  0
 2 files changed, 26 insertions(+), 14 deletions(-)
 rename DropBlox_coding_competition.ipynb => quick_start.ipynb (100%)

diff --git a/README.md b/README.md
index 8ccb53d..f9973ec 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,43 @@
-# 🟨🟦🟥 DropBlox 🟩🟧🟪 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1NmfslkeZ4TWp-PZmq6XqWjoZhABoV82W?usp=sharing)
-
+# 🟨🟦🟥 DropBlox 🟩🟧🟪 
 
 Welcome! I'm assuming you came here to give this coding challenge a try, great! After all, you could be the one to win the big price... So, let's get right to it! 
 
-First we will give you a bit more info about the challenge, but if you really can't wait, just jump straight to the "Quickstart" section.
+## Quickstart 🎬
 
-## The challenge
+You can either:
 
-The task is simple: given a rectangular field and a set of predefined blocks, fill the field with the blocks and aim to get the highest score. 
+1. Open the Colab example
 
-How do you score high? That depends on the colors of the blocks you used, the rows you filled and the amount of empty cells in the final field.
+    [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1NmfslkeZ4TWp-PZmq6XqWjoZhABoV82W?usp=sharing)
 
-## Your solution
+OR
 
-Don't worry, we took away most of the annoying work so you can focus on strategy. All you have to do is write a `.txt` file where each line specifies which block (by block ID) to drop in the field, and at which x-coordinate. 
+2. Clone this repo
 
-Submit your solution at: https://dropblox.azurewebsites.net/submit
+    ```shell
+    git clone https://github.com/godatadriven/dropblox.git
+    ```
 
-## Leaderboard
+    and open `quick_start.ipynb` ✓
 
-Go to: https://dropblox.azurewebsites.net/leaderboard
+## The rules 📜
+
+### Points scheme
+The task is simple: given a rectangular field and a set of predefined blocks, fill the field with the blocks and aim to get the highest score. 
+
+How do you score high? That depends on the colors of the blocks you used, the rows you filled and the amount of empty cells in the final field.
 
-## Quickstart
+### Submitting solutions
+Don't worry, we took away most of the annoying work so you can focus on strategy. All you have to do is write a `.txt` file where each line specifies which block (by block ID) to drop in the field, and at which x-coordinate. 
+
+> Check out the Quickstart example on how to generate the solutions file.
 
-There are two options: 1. For a really-quickstart, open [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1NmfslkeZ4TWp-PZmq6XqWjoZhABoV82W?usp=sharing) and 2. Described below.
+Submit your solution `.txt` at: https://dropblox.azurewebsites.net/submit
 
-...
+## Leaderboard 🏆
 
+Go to: https://dropblox.azurewebsites.net/leaderboard
 
 
+## About
+> This challenge is hosted by [GoDataDriven](https://godatadriven.com/) for PyConDE & PyData Berlin 2022.
\ No newline at end of file
diff --git a/DropBlox_coding_competition.ipynb b/quick_start.ipynb
similarity index 100%
rename from DropBlox_coding_competition.ipynb
rename to quick_start.ipynb