aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README4
-rw-r--r--README.md14
2 files changed, 14 insertions, 4 deletions
diff --git a/README b/README
deleted file mode 100644
index 48a1cc5..0000000
--- a/README
+++ /dev/null
@@ -1,4 +0,0 @@
-foollib
-=======
-
-A collection of C99 utilities
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2cf0c13
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+foollib
+=======
+
+A collection of C99 utilities and containers.
+
+Memory manager
+--------------
+
+The primary concept behind this repository is the `MemoryManager`.
+It provides a generic allocation/deallocation interface, allowing you to use different allocators in different scenarios.
+
+The standard allocator (`M_std`) provides a trivial wrapper over `malloc` and `free`.
+For convenience, `M_STD` is a global object, which contains the trivial wrappers.
+In case you do not want any special memory management, you should pass `M_STD` when a `MemoryManager` is required.