Getting started¶
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
Download library¶
Library is primarly hosted on Github.
You can get it with:
Downloading latest release from releases area on Github
Cloning
master
branch for latest stable versionCloning
develop
branch for latest development
Download from releases¶
All releases are available on Github releases area.
Clone from Github¶
First-time clone¶
This is used when you do not have yet local copy on your machine.
Make sure
git
is installed.Open console and navigate to path in the system to clone repository to. Use command
cd your_path
Clone repository with one of available
3
optionsRun
git clone --recurse-submodules https://github.com/MaJerle/lwrb
command to clone entire repository, including submodulesRun
git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwrb
to clone development branch, including submodulesRun
git clone --recurse-submodules --branch master https://github.com/MaJerle/lwrb
to clone latest stable branch, including submodules
Navigate to
examples
directory and run favourite example
Update cloned to latest version¶
Open console and navigate to path in the system where your resources repository is. Use command
cd your_path
Run
git pull origin master --recurse-submodules
command to pull latest changes and to fetch latest changes from submodules onmaster
branchRun
git pull origin develop --recurse-submodules
command to pull latest changes and to fetch latest changes from submodules ondevelop
branchRun
git submodule foreach git pull origin master
to update & merge all submodules
Note
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
Copy
lwrb
folder to your project, it contains library filesAdd
lwrb/src/include
folder to include path of your toolchain. This is where C/C++ compiler can find the files during compilation process. Usually using-I
flagAdd source files from
lwrb/src/
folder to toolchain build. These files are built by C/C++ compileryBuild 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[8];
6
7/* Application variables */
8uint8_t data[2]; /* 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" */