readme updates

lbf/README.md

@@ -50,29 +50,29 @@ If no config file is provided, the default configuration is used.
 The configuration file is a JSON file with the following structure:
 ```javascript
 {
-  "cde_config": { // Collision detection engine configuration
-    "quadtree_depth": 5, // Maximum depth of the quadtree is 5
-    "hpg_n_cells": 2000, // The hazard proximity grid contains 2000 cells
+  "cde_config": { //Configuration of the collision detection engine
+    "quadtree_depth": 5, //Maximum depth of the quadtree is 5
+    "hpg_n_cells": 2000, //The hazard proximity grid contains 2000 cells
     "item_surrogate_config": {
-      "pole_coverage_goal": 0.9, // The surrogate will stop generating poles when 90% of the item is covered
-      "max_poles": 10, // The surrogate will at most generate 10 poles
-      "n_ff_poles": 2, // 2 poles will be used for fail-fast collision detection
-      "n_ff_piers": 0 // 0 piers will be used for fail-fast collision detection
+      "pole_coverage_goal": 0.9, //The surrogate will stop generating poles when 90% of the item is covered
+      "max_poles": 10, //The surrogate will at most generate 10 poles
+      "n_ff_poles": 2, //Two poles will be used for fail-fast collision detection
+      "n_ff_piers": 0 //Zero piers will be used for fail-fast collision detection
     }
   },
   "poly_simpl_config": { // Polygon simplification configuration
-    "mode": "enabled", // enabled or disabled
+    "mode": "enabled", //[enabled/disabled]
     "params": {
-      "tolerance": 0.001 // The polygons will be simplified until they deviate at most 0.1% from their original area.
+      "tolerance": 0.001 //Polygons will be simplified until they deviate at most 0.1% from their original area.
     }
   },
-  "deterministic_mode": true, // The heuristic will always produce the same solution for the same input and configuration
-  "n_samples_per_item": 5000, // It will sample in total 5000 placements for each item
-  "ls_samples_fraction": 0.2 // Of those 5000, 80% will be random samples, 20% will be local search samples
+  "deterministic_mode": true, //The heuristic will always produce the same solution for the same input and configuration
+  "n_samples_per_item": 5000, //5000 placement samples will be queried per item.
+  "ls_samples_fraction": 0.2 //Of those 5000, 80% will be sampled at random, 20% will be local search samples
 }
 ```
 
-## Notes
+## Disclaimer
 
 Due to `lbf` being a one-pass constructive heuristic, the final solution quality is extremely *chaotic*. \
 Meaning that minute changes in the flow (sorting of the items, configuration, prng seed...) lead to solutions with drastically different quality. \
@@ -83,7 +83,7 @@ Testing with `deterministic_mode` set to `false` will demonstrate this spread in
 
 ## Testing
 
-`lbf` contains some basic integration tests to validate the correctness of the heuristic on a macro level. (needs to be improved and expanded)
+`lbf` contains some basic integration tests to validate the correctness of the heuristic on a macro level (needs to be improved and expanded).
 It basically runs the heuristic on a set of input files with `debug-assertions = true`.