https://github.com/eagletrt/libstm32-sw-template

Template for libraries compatible with the PlatformIO ecosystem
https://github.com/eagletrt/libstm32-sw-template

embedded platformio platformio-library sw template

Last synced: about 2 months ago
JSON representation

Template for libraries compatible with the PlatformIO ecosystem

• Host: GitHub
• URL: https://github.com/eagletrt/libstm32-sw-template
• Owner: eagletrt
• License: other
• Created: 2025-03-20T00:15:08.000Z (about 2 months ago)
• Default Branch: master
• Last Pushed: 2025-03-21T15:00:48.000Z (about 2 months ago)
• Last Synced: 2025-03-21T16:21:51.135Z (about 2 months ago)
• Topics: embedded, platformio, platformio-library, sw, template
• Homepage:
• Size: 17.6 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LIBSTM32-SW-TEMPLATE

This repository serves as a template for libraries compatible with the

[PlatformIO ecosystem](https://docs.platformio.org/en/latest/librarymanager/creating.html).

## Usage

Before starting to develop the library, a couple of things need to be done:

1. Change this README explaining the library and the functionalities that it offers

2. Modify the `library.json` including:

    - The **name** of the library

    - The library **version**

    - The **description** explaining what the library does and for which devices

    - The list of **keywords**

    - The repository **url** (and type if necessary)

    - The list of **authors**

    - The supported **frameworks** and **platforms** (if needed)

    - The list of **header files** of the library

    - The list of **examples**

    - The file of the library to **export** (if needed)

## Structure

The code of the library should be splitted in sources which must be placed inside

the `src` folder and headers which must be placed inside the `include` folder.

Inside the `example` folder multiple source files should be placed to further

explain how to use the library and how it works in different scenario.

The library must be tested with the maximum possible code coverage, the source

code used to run the unit tests should be put inside the `test` folder.

If scripts or other tools are needed for the library they must be put inside

the `tools` folder.

No other folders should be created besides the ones described before if not

necessary, to handle complex file structures nested folders can be used.

For more info check the READMEs inside the corresponding folders.