From 82ad58edc5b063f19ea912e7eb75f73d87e13fc4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= Date: Thu, 21 Jan 2016 13:20:05 +0100 Subject: [PATCH] readme + lic --- LICENSE | 22 ++++++++++++++++++++++ README.md | 9 ++++----- 2 files changed, 26 insertions(+), 5 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e35f927 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2015 Ondřej Hruška + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/README.md b/README.md index 0bea725..aa489a0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ Circular byte buffer ==================== +**(and other buffers)** + This is a circular buffer implementation, useful mainly for embedded systems (buffer for UART RX/TX queues etc). It should be reliable with producent / consumer threads (no race conditions, as no length variable is used). +A Matching buffer, and Averaging buffer are also included—see their header files for instructions. + Usage ----- @@ -37,8 +41,3 @@ Most functions return a success flag (true - success), so make sure to check the False is returned on buffer overflow / underflow. See the header file for details. -License -------- - -I don't care, public domain (I guess). -