Getting started may be the most challenging part of every new library. This guide is describing how to start with the library quickly and effectively
Library is primarly hosted on Github.
You can get it by:
Downloading latest release from releases area on Github
mainbranch for latest stable version
developbranch for latest development
Download from releases
All releases are available on Github releases area.
Clone from Github
This is used when you do not have yet local copy on your machine.
Open console and navigate to path in the system to clone repository to. Use command
Clone repository with one of available options below
git clone --recurse-submodules https://github.com/MaJerle/lwrbcommand to clone entire repository, including submodules
git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwrbto clone development branch, including submodules
git clone --recurse-submodules --branch main https://github.com/MaJerle/lwrbto clone latest stable branch, including submodules
examplesdirectory and run favourite example
Update cloned to latest version
Open console and navigate to path in the system where your repository is located. Use command
git pull origin maincommand to get latest changes on
git pull origin developcommand to get latest changes on
git submodule update --init --remoteto update submodules to latest version
This is preferred option to use when you want to evaluate library and run prepared examples. Repository consists of multiple submodules which can be automatically downloaded when cloning and pulling changes from root repository.
Add library to project
At this point it is assumed that you have successfully download library, either cloned it or from releases page. Next step is to add the library to the project, by means of source files to compiler inputs and header files in search path
lwrbfolder to your project, it contains library files
lwrb/src/includefolder to include path of your toolchain. This is where C/C++ compiler can find the files during compilation process. Usually using
Add source files from
lwrb/src/folder to toolchain build. These files are built by C/C++ compiler. CMake configuration comes with the library, allows users to include library in the project as subdirectory and library.y
Build the project
Minimal example code
To verify proper library setup, minimal example has been prepared. Run it in your main application file to verify its proper execution
1#include "lwrb/lwrb.h" 2 3/* Declare rb instance & raw data */ 4lwrb_t buff; 5uint8_t buff_data; 6 7/* Application variables */ 8uint8_t data; /* Application working data */ 9 10/* Application code ... */ 11lwrb_init(&buff, buff_data, sizeof(buff_data)); /* Initialize buffer */ 12 13/* Write 4 bytes of data */ 14lwrb_write(&buff, "0123", 4); 15 16/* Print number of bytes in buffer */ 17printf("Bytes in buffer: %d\r\n", (int)lwrb_get_full(&buff)); 18 19/* Will print "4" */