From d71821fd36eaa46947f0f6cc7dc0b236754dc501 Mon Sep 17 00:00:00 2001
From: Holger Vogt <holger.vogt@uni-due.de>
Date: Mon, 12 Jul 2021 23:34:00 +0200
Subject: [PATCH] New readme for this branch

---
 README.cpl-gc | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 README.cpl-gc

diff --git a/README.cpl-gc b/README.cpl-gc
new file mode 100644
index 000000000..2ad0e7fe9
--- /dev/null
+++ b/README.cpl-gc
@@ -0,0 +1,10 @@
+Copyright 2021 Holger Vogt
+New BSD license.
+
+A local garbage collector, especially cpl transmission line
+
+All memory allocation and deallocation are accompanied by functions from cplhash.c.
+Each time any memory is allocated, an entry is made into a hash table, storing the address.
+Each time memory is freed, this entry is removed again. Reallocation uses both procedures.
+Function mem_init() initializes the setup.
+Function mem_delete() frees all memory with addresses still found in the hash table.