base32

About base32

C++ Base32 encoding/decoding

By default:

• Warnings as errors
• clang-tidy and cppcheck static analysis
• CPM for dependencies

It includes

• unit testing using UT/μt
• fuzz testing using fuzztest
• tooling to verify consistent commits format inspired by conventional commits
• autocreation of version tags in main branch based on commits

Commits format

1. API breaking change (will increment major version) For example: removal of public interface parts after introducing new version of API Please, provide short description with reasons and migration hints if needed

api: remove deprecated v1 API
api(parser): hide parser API from public interface

2. New feature or backward compatible API change (will increment major version)

feat: introduce parser v2 API
feat(parser): extend parser v2 API public interface

3. Fix of bug in existing logic

fix: bug with list parsing in v2 API
refactor(parser): reduce heap allocations in parser v2 API

It requires

• cmake
• a compiler

Platforms and compilers support matrix:

	Windows	Ubuntu
MSVC	✔️
clang		✔️
gcc		✔️

Usage

CMake

To use base32 library in cmake project:

CPMAddPackage("gh:MarkRakhmatov/base32@v0.1.0")

Link base32 library to your target

target_link_libraries(your_target PRIVATE base32)

Examples

TODO: add code examples

Documentation

base32