Skip to content

Commit

Permalink
adds warning for library inclusion
Browse files Browse the repository at this point in the history
fixes #73
  • Loading branch information
rlogiacco authored Feb 8, 2023
1 parent 3bb51f4 commit f29cf01
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ CircularBuffer<void*,100> pointers; // uses 638 bytes

**Please note**: the memory usage reported above includes the program memory used by the library code, the heap memory is much less and is comparable to an array of the same size and type of the buffer.

### **IMPORTANT**
If you are strugglying to have your toolchain pick up the library (issues reported on Arduino Mbed and Nano33 BLE boards, but might apply to others as well) try specifying the exact path to your library, like in the following example:

``` cpp
#include <C:\Users\username\Documents\Arduino\libraries\CircularBuffer\CircularBuffer.h>
```

### Store data

Let's start making things clear: the library doesn't support inserting data in the middle of the buffer.
Expand Down

0 comments on commit f29cf01

Please sign in to comment.