aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSyndamia <kamen@syndamia.com>2026-04-30 11:12:22 +0300
committerSyndamia <kamen@syndamia.com>2026-05-12 07:08:56 +0300
commitd23f6d3be400e7f51c3171d1dbd85da8b8d430ce (patch)
tree6f6e1cec759ee729b5a4167cb106a8ea18078e11 /README.md
parent8eb996ccb042a9ddb0c69ca1d7083c431f6e03b0 (diff)
downloadfoollib-d23f6d3be400e7f51c3171d1dbd85da8b8d430ce.tar
foollib-d23f6d3be400e7f51c3171d1dbd85da8b8d430ce.tar.gz
foollib-d23f6d3be400e7f51c3171d1dbd85da8b8d430ce.zip
feat(README): Add information about memory managerHEADmain
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
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.