Library is primarly hosted on Github.
- Download latest release from releases area on Github
- Clone develop branch for latest development
All releases are available on Github releases area.
- Download and install
git
if not already - 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
options- Run
git clone --recurse-submodules https://github.com/MaJerle/lwgsm
command to clone entire repository, including submodules - Run
git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwgsm
to clone development branch, including submodules - Run
git clone --recurse-submodules --branch master https://github.com/MaJerle/lwgsm
to clone latest stable branch, including submodules
- Run
- Navigate to
examples
directory and run favourite example
- 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 - Run
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.
At this point it is assumed that you have successfully download library, either cloned it or from releases page.
- Copy
lwgsm
folder to your project - Add
lwgsm/src/include
folder to include path of your toolchain - Add port architecture
lwgsm/src/include/system/port/_arch_
folder to include path of your toolchain - Add source files from
lwgsm/src/
folder to toolchain build - Add source files from
lwgsm/src/system/
folder to toolchain build for arch port - Copy
lwgsm/src/include/lwgsm/lwgsm_opts_template.h
to project folder and rename it tolwgsm_opts.h
- Build the project
Library comes with template config file, which can be modified according to needs.
This file shall be named lwgsm_opts.h
and its default template looks like the one below.
Note
Default configuration template file location: lwgsm/src/include/lwgsm/lwgsm_opts_template.h
.
File must be renamed to lwgsm_opts.h
first and then copied to the project directory (or simply renamed in-place) where compiler
include paths have access to it by using #include "lwgsm_opts.h"
.
Tip
Check :ref:`api_lwgsm_opt` section for possible configuration settings
.. literalinclude:: ../../lwgsm/src/include/lwgsm/lwgsm_opts_template.h :language: c :linenos: :caption: Template options file