Skip to content

Latest commit

 

History

History
93 lines (47 loc) · 2.84 KB

INSTALL.md

File metadata and controls

93 lines (47 loc) · 2.84 KB
Raw

Install

The library can be found, installed, or updated from the Arduino IDE using the official Arduino Library Manager (available from IDE version 1.6.2).

The library can be installed on the system by following the same steps as with other Arduino library.

Refer to Installing Additional Arduino Libraries tutorial for details on how to install a third party library.

Build

The library unit tests can be build on Windows/Linux platform to maintain the product stability and level of quality.

This section explains how to compile and build the software and how to get a test environment ready.

Prerequisites

Software Requirements

The following software must be installed on the system before compiling source code:

Linux Requirements

These are the base requirements to build source code:

  • GNU-compatible Make or gmake
  • POSIX-standard shell
  • A C++98-standard-compliant compiler

Windows Requirements

  • Microsoft Visual C++ 2010 or newer

Build steps

The BitReader unit test uses the CMake build system to generate a platform-specific build environment. CMake reads the CMakeLists.txt files, checks for installed dependencies and then generates files for the selected build system.

The following steps show how to build the library:

  1. Download the source code from an existing tags and extract the content to a local directory (for example c:\projects\BitReader or ~/dev/BitReader).

  2. Open a Command Prompt (Windows) or Terminal (Linux) and browse to the project directory.

  3. Enter the following commands to generate the project files for your build system:

mkdir build
cd build
cmake ..
  1. Build the source code.

Windows

cmake --build . --config Release

Linux

make

Testing

BitReader comes with unit tests which help maintaining the product stability and level of quality.

Test are build using the Google Test v1.8.0 framework. For more information on how googletest is working, see the google test documentation primer.

To run tests, open a shell prompt and browse to the build/bin folder and run bitreader_unittest executable. For Windows users, the executable is located in build\bin\Release.

Test results are saved in junit format in file bitreader_unittest.release.xml.

The latest test results are available at the beginning of the README.md file.