picolibrary

A C++ microcontroller driver/utility library targeted for use with resource constrained microcontrollers.

Obtaining the Source Code

HTTPS:

git clone --recurse-submodules https://github.com/apcountryman/picolibrary.git

SSH:

git clone --recurse-submodules git@github.com:apcountryman/picolibrary.git

Documentation

Library usage documentation, documentation for key library concepts, and documentation for major library features can be found at https://apcountryman.github.io/picolibrary/. All other documentation is embedded in the library source code.

Versioning

Post version 0.1.0, picolibrary will follow the Abseil Live at Head philosophy.

Workflow

picolibrary uses the GitHub flow workflow.

Git Hooks

To install this repository's Git hooks, execute the install script located in the git/hooks directory. See the install script's help text for usage details.

./git/hooks/install --help

Code of Conduct

picolibrary has adopted the Contributor Covenant 2.0 code of conduct. For more information, see the CODE_OF_CONDUCT.md file in this repository.

Contributing

If you are interested in contributing to picolibrary, please read the CONTRIBUTING.md file in this repository.

Authors

• Andrew Countryman
• Jay Lamb

License

picolibrary is licensed under the Apache License, Version 2.0. For more information, see the LICENSE file in this repository.