Merge remote-tracking branch 'jagua-rs/main'

JeroenGar · Feb 24, 2024 · 4b425eb · 4b425eb
2 parents cc66c29 + e287636
commit 4b425eb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/jagua-rs/README.md b/jagua-rs/README.md
@@ -1,4 +1,4 @@
-# Jagua-rs
+# Jagua-rs 🐆
 
 This crate contains everything necessary to solve 2D irregular cutting and packing problems without the combinatorial decision-making (i.e. which items to place where).
 
@@ -31,8 +31,8 @@ See [lbf crate](../lbf) for a reference implementation of an optimization algori
 
 ## Documentation
 
-The code is documented with rustdoc.
-The docs can be build using `cargo doc --open` from the root of the repository.
+The codebase is documented throughout using [rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html).
+Use `cargo doc --open` to compile and view the documentation in your browser.
 
 ## Testing
 

diff --git a/lbf/README.md b/lbf/README.md
@@ -1,4 +1,4 @@
-# LBF
+# LBF ↙️
 A left-bottom-fill heuristic for 2D irregular cutting and packing problems using the `jagua-rs` collision detection engine.
 
 This heuristic serves as a reference implementation of how to use the collision detection engine. \