summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorOlivier Gayot <duskcoder@gmail.com>2013-12-26 15:23:45 +0100
committerOlivier Gayot <duskcoder@gmail.com>2014-01-18 13:44:42 +0100
commit6dd71f30872bb65d6959dd6ed2ac015c5739f98a (patch)
tree455843c7e1ff96f4fe76954aeb625eea0099b7ba /README
parentbd9efbd97da6d97a1a19522fed29d3c9c4d7d91b (diff)
rb: use the autotools to generate the library
the library is not built using the autotools. the advantages of this improvement are: * we can do a make install / make uninstall / make dist / and so on * the library is not (unless specified) built as a shared and static library * some portability issues will be easier to fix.
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.