Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.28 KB

index.rst

File metadata and controls

86 lines (60 loc) · 3.28 KB
Raw

Getting started

Download library

Library is primarly hosted on Github.

  • Download latest release from releases area on Github
  • Clone develop branch for latest development

Download from releases

All releases are available on Github releases area.

Clone from Github

First-time clone

  • 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/lwjson command to clone entire repository, including submodules
    • Run git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwjson to clone development branch, including submodules
    • Run git clone --recurse-submodules --branch master https://github.com/MaJerle/lwjson 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
  • 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.

Add library to project

At this point it is assumed that you have successfully download library, either cloned it or from releases page.

  • Copy lwjson folder to your project
  • Add lwjson/src/include folder to include path of your toolchain
  • Add source files from lwjson/src/ folder to toolchain build
  • Copy lwjson/src/include/lwjson/lwjson_opts_template.h to project folder and rename it to lwjson_opts.h
  • Build the project

Configuration file

Library comes with template config file, which can be modified according to needs. This file shall be named lwjson_opts.h and its default template looks like the one below.

Note

Default configuration template file location: lwjson/src/include/lwjson/lwjson_opts_template.h. File must be renamed to lwjson_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 "lwjson_opts.h".

Tip

Check api_lwjson_opt section for possible configuration settings

../../lwjson/src/include/lwjson/lwjson_opts_template.h

Minimal example code

Run below example to test and verify library

../../examples/example_minimal.c