content: Add notes on no_std compatibility.

kpreid · Oct 4, 2024 · ab1f022 · ab1f022
1 parent bd1ca4c
commit ab1f022
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/all-is-cubes-content/Cargo.toml b/all-is-cubes-content/Cargo.toml
@@ -39,9 +39,9 @@ hashbrown = { workspace = true }
 itertools = { workspace = true }
 log = { workspace = true }
 macro_rules_attribute = { workspace = true }
-noise = { workspace = true }
+noise = { workspace = true } # TODO: not no_std compatible (fixable)
 paste = { workspace = true }
-petgraph = { workspace = true }
+petgraph = { workspace = true } # TODO: not no_std compatible (might become so someday)
 rand = { workspace = true }
 rand_xoshiro = { workspace = true }
 strum = { workspace = true, features = ["derive"] }

diff --git a/all-is-cubes-content/src/lib.rs b/all-is-cubes-content/src/lib.rs
@@ -7,6 +7,10 @@
 //! provide [`UniverseTemplate`]; other items should be assumed not particularly
 //! stable.
 
+// This crate is *almost* `no_std` compatible; critically, some dependencies are not.
+// See comments in `Cargo.toml` for details.
+// For now, the code is just in a state of “reveal how close it is”, hence using `core` and
+// `alloc` imports only.
 #![no_std]
 //
 // Crate-specific lint settings. (General settings can be found in the workspace manifest.)