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 with:
Downloading latest release from releases area on Github
masterbranch for latest stable version
developbranch for latest development
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
git clone --recurse-submodules https://github.com/MaJerle/lwespcommand to clone entire repository, including submodules
git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwespto clone development branch, including submodules
git clone --recurse-submodules --branch master https://github.com/MaJerle/lwespto 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 resources repository is. Use command
git pull origin master --recurse-submodulescommand to pull latest changes and to fetch latest changes from submodules on
git pull origin develop --recurse-submodulescommand to pull latest changes and to fetch latest changes from submodules on
git submodule foreach git pull origin masterto update & merge all submodules
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
lwespfolder to your project, it contains library files
lwesp/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
lwesp/src/folder to toolchain build. These files are built by C/C++ compiler
lwesp/src/include/lwesp/lwesp_opts_template.hto project folder and rename it to
Build the project
Configuration file is used to overwrite default settings defined for the essential use case.
Library comes with template config file, which can be modified according to needs.
and it should be copied (or simply renamed in-place) and named
Default configuration template file location:
File must be renamed to
lwesp_opts.h first and then copied to the project directory where compiler
include paths have access to it by using
List of configuration options are available in the api_lwesp_opt section. If any option is about to be modified, it should be done in configuration file
If you prefer to avoid using configuration file, application must define
a global symbol
LWESP_IGNORE_USER_OPTS, visible across entire application.
This can be achieved with
-D compiler option.