Skip to content

Commit 43e87e8

Browse files
committed
++
1 parent 648030d commit 43e87e8

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,13 @@
33

44
# SparkFun How To Arduino Library
55

6+
> [!NOTE]
7+
> Update this with a single sentence about this library
8+
69
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.
710

11+
> [!NOTE]
12+
> Update these links and URLs for the badges to work correctly
813
914
![GitHub License](https://img.shields.io/github/license/sparkfun/SparkFun_Arduino_Library_HowTo)
1015
![Release](https://img.shields.io/github/v/release/sparkfun/SparkFun_Arduino_Library_HowTo)
@@ -13,7 +18,7 @@ GitHub repository that outlines how to build a modern SpakRun Arduino Library, w
1318
[![Compile Test](https://github.com/sparkfun/SparkFun_Arduino_Library_HowTo/actions/workflows/cross-compilation.yml/badge.svg)](https://github.com/sparkfun/SparkFun_Arduino_Library_HowTo/actions/workflows/cross-compilation.yml)
1419
![GitHub issues](https://img.shields.io/github/issues/sparkfun/SparkFun_Arduino_Library_HowTo)
1520

16-
> [!INFO]
21+
> [!NOTE]
1722
> Details on how to setup a SparkFun Arduino Library are contained the [HOWTO.md](HOWTO.md) file in this repository. This file 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.
1823
1924
*Enter a description of the library here*
@@ -35,7 +40,7 @@ This library allows you to:
3540

3641
# Documentation
3742

38-
> [!INFO]
43+
> [!NOTE]
3944
> *Link to documentation for this library here*
4045
4146
* **[Library Documentation](https://docs.sparkfun.com/SparkFun_Arduino_Library_HowTo/)** - Arduino Library Documentation for this repository.
@@ -46,6 +51,9 @@ This library allows you to:
4651

4752
## Products That Use This Library
4853

54+
> [!NOTE]
55+
> List the SparkFun products that use this library here
56+
4957
* [[TODO: SKU]](https://www.sparkfun.com/) - *Product 1 Name*
5058
* [[TODO: SKU]](https://www.sparkfun.com/) - *Product 2 Name*
5159

0 commit comments

Comments
 (0)