Skip to content

Commit 46f2630

Browse files
authored
Update README.md
1 parent 1002453 commit 46f2630

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,32 @@
1+
CircularBuffer_CPP
2+
===========
3+
14
[![Actions Status](https://github.com/vinitjames/circularbuffer_CPP/workflows/Build%20and%20Test/badge.svg)](https://github.com/vinitjames/circularbuffer_CPP/actions)
25

36

7+
## About
8+
circularbuffer_CPP is a simple, general purpose STL style [circularbuffer](https://en.wikipedia.org/wiki/Circular_buffer) implementation in C++.
9+
10+
11+
## Features
12+
* STL style implementaion of Circular Buffer
13+
* Lightweight (only single header file)
14+
* Simple API conforming to STL container semantics.
15+
* Random Access Iterator for easy forwad and reverse iteration and looping through elements.
16+
* Test suites
17+
18+
## Installation
19+
Run:
20+
```
21+
git clone https://github.com/vinitjames/circularbuffer_CPP.git
22+
```
23+
# Without CMAKE
24+
copy circular_buffer.h to your project
425

5-
#A simple, general purpose STL style circular buffer in C++
26+
# With CMAKE to run tests
27+
Run ```mkdir build
28+
cd build
29+
cmake ..
30+
cmake --build .
31+
ctest ```
32+
to compile and run tests.

0 commit comments

Comments
 (0)