GitHub repository that outlines how to build a modern SpakRun Arduino Library, which includes use of the SparkFun Toolkit, and Doxygen generated documentation that is published via GitHub Pages.
NOTE:
Details on how to setup a SparkFun Arduino Library are contained the how to sections further down in this file. This sections contains step-by-step instructions on how to create a SparkFun Arduino Library repository, including how to use the SparkFun Toolkit, and how to setup documentation generation and deployment using GitHub Actions and GitHub Pages.
Enter a description of the library here
This library allows you to:
- Build a SparkFun Arduino Library repository - see the howto sections later in this file file for details on creating a repository.
- Implement a GitHub Action that preforms a cross-compile check of the library
- Uses doxygen to generate documentation for the library and publish the results to GitHub Pages
- /examples - Example sketches for the library (.ino). Run these from the Arduino IDE.
- /src - Source files for the library (.cpp, .h).
- /docs - configuration files for the documentation.
- keywords.txt - Keywords from this library that will be highlighted in the Arduino IDE.
- library.properties - General library properties for the Arduino package manager.
- Library Documentation - Arduino Library Documentation for this repository.
- Hookup Guide - Hookup guide for the the product associated with this library.
- Installing an Arduino Library Guide - Basic information on how to install an Arduino library.
- Hardware GitHub Repository - Qwiic 1x1 - Main repository (including hardware files) for product that uses this library. List all products here, on desperate lines.
- [TODO: SKU] - Product 1 Name
- [TODO: SKU] - Product 2 Name
This product is open source!
This product is licensed using the MIT Open Source License