Skip to content

Commit 900f9ec

Browse files
Update template files
1 parent 6382063 commit 900f9ec

File tree

4 files changed

+187
-0
lines changed

4 files changed

+187
-0
lines changed

.gitignore

+111
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@
1919
## BOM files
2020
*bom*
2121

22+
<<<<<<< Updated upstream
23+
=======
24+
## VSCode directories
25+
.vscode
26+
27+
>>>>>>> Stashed changes
2228
#################
2329
## Eclipse
2430
#################
@@ -54,9 +60,39 @@ local.properties
5460
## Eagle
5561
#############
5662

63+
<<<<<<< Updated upstream
5764
# Ignore the board and schematic backup files
5865
*.b#?
5966
*.s#?
67+
=======
68+
# Ignore the board and schematic backup files and lock files
69+
*.b#?
70+
*.s#?
71+
*.l#?
72+
*.lck
73+
74+
75+
#############
76+
## KiCad
77+
#############
78+
79+
*cache.lib
80+
*.kicad_pcb-bak
81+
*.net
82+
*.gbr
83+
*.drl
84+
85+
#KiCad Backup files
86+
*.kicad_prl
87+
fp-info-cache
88+
~*.lck
89+
*-bak
90+
*-backups
91+
*-cache*
92+
*-bak*
93+
_autosave*
94+
\#auto_saved_files\#
95+
>>>>>>> Stashed changes
6096

6197

6298
#################
@@ -145,12 +181,23 @@ Backup*/
145181
UpgradeLog*.XML
146182

147183

184+
<<<<<<< Updated upstream
185+
=======
186+
# =========================
187+
# Operating System Files
188+
# =========================
189+
190+
>>>>>>> Stashed changes
148191
############
149192
## Windows
150193
############
151194

152195
# Windows image file caches
153196
Thumbs.db
197+
<<<<<<< Updated upstream
198+
=======
199+
ehthumbs.db
200+
>>>>>>> Stashed changes
154201

155202
# Folder config file
156203
Desktop.ini
@@ -160,6 +207,7 @@ Desktop.ini
160207
## Python
161208
#############
162209

210+
<<<<<<< Updated upstream
163211
*.py[co]
164212

165213
# Packages
@@ -174,6 +222,11 @@ var
174222
sdist
175223
develop-eggs
176224
.installed.cfg
225+
=======
226+
#############
227+
## Mac OS
228+
#############
229+
>>>>>>> Stashed changes
177230

178231
# Installer logs
179232
pip-log.txt
@@ -190,3 +243,61 @@ pip-log.txt
190243

191244
# Mac crap
192245
.DS_Store
246+
<<<<<<< Updated upstream
247+
=======
248+
249+
# OSX
250+
# ===========
251+
.AppleDouble
252+
.LSOverride
253+
254+
#############
255+
## Linux
256+
#############
257+
258+
# backup files (*.bak on Win)
259+
*~
260+
261+
262+
#############
263+
## Python
264+
#############
265+
266+
*.py[co]
267+
268+
# Packages
269+
*.egg
270+
*.egg-info
271+
dist
272+
build
273+
eggs
274+
parts
275+
bin
276+
var
277+
sdist
278+
develop-eggs
279+
.installed.cfg
280+
281+
# Icon must ends with two \r.
282+
Icon
283+
284+
# Installer logs
285+
pip-log.txt
286+
287+
# Unit test / coverage reports
288+
.coverage
289+
.tox
290+
291+
# Thumbnails
292+
._*
293+
294+
#Translations
295+
*.mo
296+
297+
# Files that might appear on external disk
298+
.Spotlight-V100
299+
.Trashes
300+
301+
#Mr Developer
302+
.mr.developer.cfg
303+
>>>>>>> Stashed changes

CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### How to Contribute
2+
3+
Thank you so *much* for offering to help out. We truly appreciate it.
4+
5+
If you'd like to contribute, start by searching through the [issues](../../issues) and [pull requests](../../pulls) to see whether someone else has raised a similar idea or question.
6+
7+
If you are adding a feature to this library, please create a PR and follow these best practices:
8+
9+
* If you've added a new feature document it with a simple example sketch. This serves both as a test of your PR and as a quick way for users to quickly learn how to use your new feature.
10+
* If you add new functions also add them to keywords.txt so that they are properly highlighted in Arduino. [Read more](https://www.arduino.cc/en/Hacking/libraryTutorial).
11+
* PRs should change as little as possible. Do not submit a PR that changes 100 lines of whitespace. Break up into multiple PRs if necessary.
12+
13+
## Style guide
14+
15+
Please read and follow the [Arduino API style guide](https://www.arduino.cc/en/Reference/APIStyleGuide). Also read and consider the [Arduino style guide](https://www.arduino.cc/en/Reference/StyleGuide).

ISSUE_TEMPLATE.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Subject of the issue
2+
Describe your issue here.
3+
4+
### Your workbench
5+
* What development board or microcontroller are you using?
6+
* What version of hardware or breakout board are you using?
7+
* How is the breakout board wired to your microcontroller?
8+
* How is everything being powered?
9+
* Are there any additional details that may help us help you?
10+
11+
### Steps to reproduce
12+
Tell us how to reproduce this issue. Please post stripped down example code demonstrating your issue.
13+
14+
### Expected behavior
15+
Tell us what should happen
16+
17+
### Actual behavior
18+
Tell us what happens instead

LICENSE.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
SparkFun License Information
2+
============================
3+
4+
SparkFun uses two different licenses for our files — one for hardware and one for code.
5+
6+
Hardware
7+
---------
8+
9+
**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
10+
11+
Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
12+
13+
You are free to:
14+
15+
Share — copy and redistribute the material in any medium or format
16+
Adapt — remix, transform, and build upon the material for any purpose, even commercially.
17+
The licensor cannot revoke these freedoms as long as you follow the license terms.
18+
Under the following terms:
19+
20+
Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
21+
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
22+
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
23+
24+
Notices:
25+
26+
You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
27+
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
28+
29+
30+
Code
31+
--------
32+
33+
**SparkFun code, firmware, and software are released under the [MIT License](http://opensource.org/licenses/MIT).**
34+
35+
The MIT License (MIT)
36+
37+
Copyright (c) 2025 SparkFun Electronics
38+
39+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
40+
41+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
42+
43+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)