Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 2.33 KB

README.md

File metadata and controls

56 lines (34 loc) · 2.33 KB

amp-preview (Possibly Real-time Embedded Views)

Continuous Integration Linting & Formatting Static Analysis

License: MIT

Description: amp-preview is a C++ framework for creating embedded user interfaces.

Dependencies

Preview requires:

Preview is know to build under the following configurations:

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

How to build the software

Preview 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 Preview by itself.

cmake -B Build
cmake --build Build

How to test the software

After Preview has been built the included automated tests can be run with CTest like this:

ctest -D Experimental -C Debug

Code examples

Code examples can be found under the examples folder.

Contributing

Conventional Commits

amp-preview uses semantic versioning and conventional commits.

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

License

amp-preview is licenced under the MIT license. See LICENSE file.