improved readme's

README.md

@@ -1,3 +1,43 @@
 # Jagua-rs ![workflow](https://github.com/JeroenGar/jagua-rs/actions/workflows/rust.yml/badge.svg)
+**An open-source collision detection engine for 2D irregular cutting and packing problems writen in Rust 🦀.**
 
-🚧 Under construction 🚧
+<img src="assets/jaguars_logo.svg" width="50%" alt="Jaguars logo">
+
+# 🚧 Under construction 🚧
+
+## Introduction
+2D irregular cutting and packing (C&P) problems are a class of optimization problems that involve placing irregular shaped items into containers in an efficient way.
+These problems typically contain two challenges:
+ * **Combinatorial** challenge: deciding which items to place where to minimize some objective function.
+ * **Geometric** challenge: can we place an item at a certain position without colliding with other items? (feasibility check)
+
+`Jagua-rs` aims to decouple these two challenges by developing a Collision Detection Engine (CDE) that can be used to efficiently deal with the geometric challenges at hand.
+
+
+## Contents
+
+### Jaguars
+The `jaguars` crate all required logic for modeling 2D irregular cutting and packing problems in addition to the CDE.
+
+**See [jaguars](jaguars) for more information.**
+
+## LBF
+In addition, a reference implementation of an optimization algorithm which uses the CDE is also provided. \
+`lbf` is a simple left-bottom-fill heuristic, which places the items one-by-one in the bin each time at the left-bottom most position.
+It should provide a good starting point for anyone looking to create a more advanced optimization algorithm using ``jaguars``.
+
+**See [lbf](lbf) for more information.**
+
+## Assets
+
+TODO
+
+## Acknowledgements
+
+This project was funded by [Research Foundation - Flanders (FWO)](https://www.fwo.be/en/) (grant number: 1S71222N)
+
+<img src="https://upload.wikimedia.org/wikipedia/commons/f/fc/Fonds_Wetenschappelijk_Onderzoek_logo.svg" width="10%" alt="FWO logo">
+
+## License
+
+This project is licensed under the Mozilla Public License 2.0 - see the [LICENSE](LICENSE) file for details.

assets/config_lbf.json

@@ -5,8 +5,8 @@
     "item_surrogate_config": {
       "pole_coverage_goal": 0.9,
       "max_poles": 10,
-      "n_ff_poles": 1,
-      "n_ff_piers": 1
+      "n_ff_poles": 2,
+      "n_ff_piers": 0
     }
   },
   "poly_simpl_config": {
@@ -15,31 +15,7 @@
       "tolerance": 0.001
     }
   },
-  "deterministic_mode": false,
+  "deterministic_mode": true,
   "n_samples_per_item": 5000,
-  "ls_samples_fraction": 0.2,
-  "svg_draw_options": {
-    "theme": {
-      "stroke_width_multiplier": 2.0,
-      "bin_fill": "#CC824A",
-      "item_fill": "#FFC879",
-      "hole_fill": "#2D2D2D",
-      "qz_fill": [
-        "#000000",
-        "#FF0000",
-        "#FF5E00",
-        "#FFA500",
-        "#FFAD00",
-        "#FFFF00",
-        "#CBFF00",
-        "#CBFF00",
-        "#CBFF00",
-        "#CBFF00"
-      ],
-      "qz_stroke_opac": 0.5
-    },
-    "quadtree": false,
-    "haz_prox_grid": false,
-    "surrogate": false
-  }
+  "ls_samples_fraction": 0.2
 }