summary refs log tree commit diff
path: root/src/libnm-std-aux/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/libnm-std-aux/README.md')
-rw-r--r--src/libnm-std-aux/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/libnm-std-aux/README.md b/src/libnm-std-aux/README.md
new file mode 100644
index 00000000..ccc48e9d
--- /dev/null
+++ b/src/libnm-std-aux/README.md
@@ -0,0 +1,16 @@
+libnm-std-aux
+=============
+
+A static helper library with general purpose helpers on top of
+standard C (C11).
+
+As this has no additional dependencies, we should have all our C code
+use this internal helper library. It contains helpers that should be
+available (and used) everywhere where we write C.
+
+Our C is gnu11, that is C11 or newer with some GCC-ism. The requirement
+is that it is supported by all complilers we care about (in pratice GCC
+and Clang).
+
+Parts of this library are usually already included via the `nm-default*.h`
+headers.