philips-software / amp-embedded-infra-lib

amp-embedded-infra-lib is a set of C++ libraries and headers that provide heap-less, STL like, infrastructure for embedded software development

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

amp-embedded-infra-lib (EmIL)

Continuous Integration Linting & Formatting Static Analysis

Quality Gate Status Coverage Duplicated Lines (%)

License: MIT Documentation OpenSSF Scorecard CII Best Practices

Description: amp-embedded-infra-lib is a set of C++ libraries and headers that provide heap-less, STL like, infrastructure for embedded software development.

Dependencies

EmIL requires:

  • A recent C++ compiler that supports C++17 at minimum (for a host build it should support std::filesystem).
  • CMake 3.24 or higher.

EmIL is know to build under the following configurations:

  • Windows from Visual Studio 2019 onwards.
  • Linux from GCC 7 onwards.
  • OSX from XCode 11 and target platform 10.15 onwards.

How to build the software

EmIL can be built by-itself, for example to execute the included micro-tests, or it can be built as part of a larger project. This paragraph describes how to build EmIL by-itself.

cmake -B Build
cmake --build Build

How to test the software

After EmIL has been built. The included automated tests can be run with CTest like so:

ctest -D Experimental -C Debug

Code examples

Code examples can be found under the examples folder.

Documentation

Documentation is available on philips-software.github.io/amp-embedded-infra-lib.

Contributing

Conventional Commits

amp-embedded-infra-lib uses semantic versioning and conventional commits.

Please refer to our Contributing guide when you want to contribute to this project.

License

amp-embedded-infra-lib is licensed under the MIT license. See LICENSE file.

About

amp-embedded-infra-lib is a set of C++ libraries and headers that provide heap-less, STL like, infrastructure for embedded software development

License:MIT License


Languages

Language:C++ 97.3%Language:CMake 2.7%Language:C 0.0%Language:Dockerfile 0.0%Language:Shell 0.0%