Merge pull request #113 from hapsoc/more-readmes

chore: Add more READMEs

crates/fluke-buffet/README.md

@@ -0,0 +1,19 @@
+# fluke-buffet
+
+This crate is mostly a terrible idea, but it's doing buffer management
+for `fluke`.
+
+It's designed to memmap a big chunk of memory and then, well, hand out
+reference-counted (non-thread-safe) pieces of it. It was faster than stack
+allocation in some benchmark I did a while ago.
+
+Also, it's compatible with io_uring in that you can give ownership of one of the
+pieces to a read/write operation and nobody else is able to use it until that
+operation is done, which is really neat.
+
+There's a bunch of splitting operations that try to maintain reference count
+and the general "one mutable reference XOR multiple read-only references" vibe
+of the whole endeavor.
+
+I'm not honestly convinced buffet is the optimal way to go about this, but it
+works for now, it's io_uring and fallback-codepath friendly... ah well.

crates/fluke-maybe-uring/Cargo.toml

@@ -5,6 +5,7 @@ edition = "2021"
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/hapsoc/fluke"
 documentation = "https://docs.rs/fluke-maybe-uring"
+readme = "README.md"
 description = """
 Replicates some tokio-uring types to allow building code without it
 """

crates/fluke-maybe-uring/README.md

@@ -0,0 +1,5 @@
+# fluke-maybe-uring
+
+fluke uses [tokio-uring](https://crates.io/crates/tokio-uring), but it also
+tries to function on platforms where io_uring is not available: this crate
+abstracts over "classic tokio" I/O types and tokio-uring types.