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
- Cloning
main
branch for latest stable version - Cloning
develop
branch for latest development
All releases are available on Github releases area.
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 options below
- Run
git clone --recurse-submodules https://github.com/MaJerle/lwprintf
command to clone entire repository, including submodules - Run
git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwprintf
to clone development branch, including submodules - Run
git clone --recurse-submodules --branch main https://github.com/MaJerle/lwprintf
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 repository is located. Use command
cd your_path
- Run
git pull origin main
command to get latest changes onmain
branch - Run
git pull origin develop
command to get latest changes ondevelop
branch - Run
git submodule update --init --remote
to update submodules to latest version
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. Next step is to add the library to the project, by means of source files to compiler inputs and header files in search path.
CMake is the main supported build system. Package comes with the CMakeLists.txt
and library.cmake
files, both located in the lwprintf
directory:
CMakeLists.txt
: Is a wrapper and only includeslibrary.cmake
file. It is used if target application usesadd_subdirectory
and then usestarget_link_libraries
to include the library in the projectlibrary.cmake
: It is a fully configured set of variables. User must useinclude(path/to/library.cmake)
to include the library and must manually add files/includes to the final target
Tip
Open library.cmake
file and manually analyze all the possible variables you can set for full functionality.
If you do not use the CMake, you can do the following:
- Copy
lwprintf
folder to your project, it contains library files - Add
lwprintf/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
flag - Add source files from
lwprintf/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. - Copy
lwprintf/src/include/lwprintf/lwprintf_opts_template.h
to project folder and rename it tolwprintf_opts.h
- 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 the application needs. and it should be copied (or simply renamed in-place) and named lwprintf_opts.h
Note
Default configuration template file location: lwprintf/src/include/lwprintf/lwprintf_opts_template.h
. File must be renamed to lwprintf_opts.h
first and then copied to the project directory where compiler include paths have access to it by using #include "lwprintf_opts.h"
.
Tip
If you are using CMake build system, define the variable LWPRINTF_OPTS_DIR
before adding library's directory to the CMake project. Variable must set the output directory path. CMake will copy the template file there, and name it as required.
Configuration options list is available available in the api_lwprintf_opt
section. If any option is about to be modified, it should be done in configuration file
../../lwprintf/src/include/lwprintf/lwprintf_opts_template.h
Note
If you prefer to avoid using configuration file, application must define a global symbol LWPRINTF_IGNORE_USER_OPTS
, visible across entire application. This can be achieved with -D
compiler option.
To verify proper library setup, minimal example has been prepared. Run it in your main application file to verify its proper execution
../examples_src/example_minimal.c