https://github.com/werediver/fmtlib_pio

A way to publish fmtlib/fmt as a PlatformIO library
https://github.com/werediver/fmtlib_pio

Last synced: about 1 year ago
JSON representation

A way to publish fmtlib/fmt as a PlatformIO library

• Host: GitHub
• URL: https://github.com/werediver/fmtlib_pio
• Owner: werediver
• License: mit
• Created: 2021-06-20T14:35:10.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-06-26T13:37:12.000Z (almost 5 years ago)
• Last Synced: 2024-10-19T07:52:45.292Z (over 1 year ago)
• Language: Shell
• Size: 4.88 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
[![PlatformIO fmt](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=PlatformIO&prefix=fmt%20&query=%24.versions%5B0%5D.name&url=https%3A%2F%2Fapi.registry.platformio.org%2Fv3%2Fpackages%2Fwerediver%2Flibrary%2Ffmt)](https://platformio.org/lib/show/12455/fmt)

# fmtlib_pio

This repository contains a [PlatformIO library manifest](https://docs.platformio.org/en/latest//librarymanager/config.html) template for [fmtlib/fmt](https://github.com/fmtlib/fmt) (a modern C++ string formatting library) and a shell-script to fetch an fmt release and publish it to the [PlatformIO library registry](https://platformio.org/lib).

## Usage

Make sure you have a [PlatformIO account](https://docs.platformio.org/en/latest//plus/pio-account.html) and you are logged-in.

Check [fmtlib/fmt/releases](https://github.com/fmtlib/fmt/releases) and choose a version you want to publish as a PlatformIO library.

Run `./mk_fmtlib_pio.sh x.y.z` substituting the actual version for `x.y.z`.

The script downloads the archived source-code for the specified release version, unpacks it into `fmt-x.y.z` directory, and copies the manifest template into the same directory substituting the actual data for placeholders (currently only the version).

Now is a good time to test the combination of the new release and the manifest by building a PlatformIO library archive with [pio package pack](https://docs.platformio.org/en/latest//core/userguide/package/cmd_pack.html) and trying it out in a test project ([pio lib install](https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install.html) can install libraries from archives).

## Limitations

As of [v8.0.0](https://github.com/fmtlib/fmt/releases/tag/8.0.0) fmt introduced a C++20 module definition in [src/fmt.cc](https://github.com/fmtlib/fmt/blob/9e8b86fd2d9806672cc73133d21780dd182bfd24/src/fmt.cc). Because C++20 support is currently [not as mature](https://web.archive.org/web/20210607125616/https://en.cppreference.com/w/cpp/compiler_support/20) comparing to older standards, this file is excluded from the library.

As of [v7.1.3](https://github.com/fmtlib/fmt/releases/tag/7.1.3) fmt includes one module requiring POSIX interfaces: [src/os.cc](https://github.com/fmtlib/fmt/blob/7bdf0628b1276379886c7f6dda2cef2b3b374f0b/src/os.cc), [include/fmt/os.h](https://github.com/fmtlib/fmt/blob/7bdf0628b1276379886c7f6dda2cef2b3b374f0b/include/fmt/os.h). Because PlatformIO is an embedded development platform and majority of embedded targets don't have a POSIX-compatible OS on-board, these files are excluded from the library.