summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README26
1 files changed, 26 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..ee3424b
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+ring_buffer
+===========
+
+A ready to use library meant to deal with ring buffers.
+
+Installation
+============
+
+$ autoreconf -i
+should do the necessary to generate the ./configure script
+
+if aclocal complains about a missing m4 directory, just create it
+
+$ mkdir m4
+
+then read the INSTALL file or simply do a
+
+$ ./configure && make && [sudo] make install
+
+which should do the trick
+
+License
+=======
+
+This library is free software covered by the GPL license v2. You should
+read the COPYING file to understand what is implied.