Big-ish rework and cleanup; a README even.

1 files changed, 17 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..07f3cef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Simple Allocators
+
+If you're curious about simple memory allocation schemes in C, maybe you'll be
+able to learn a thing or two here.
+
+## Limitations
+
+I've tried to keep the code for these allocators as simple as possible, so if
+you want to use any of them "in production" you'll have to add a few more bells
+and whistles.
+For starters, real programs will require more than just one object size, so you
+will have to generalize the code for *cached* and *pool* allocators to support
+"allocator objects" of some kind.
+The *arena* allocator already supports "arbitrary" object sizes, but it has a
+fixed maximum capacity that may not be appropriate for all programs; code to
+"grow" the arena when necessary might be a good addition.
+Nothing here is thread-safe either, so you may need to throw in a lock or three.