Skip to content

Commit bef5b51

Browse files
NPooleNPoole
committed
Initial commit
0 parents  commit bef5b51

File tree

13 files changed

+449
-0
lines changed

13 files changed

+449
-0
lines changed

‎.gitattributes

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto
3+
4+
# Custom for Visual Studio
5+
*.cs diff=csharp
6+
*.sln merge=union
7+
*.csproj merge=union
8+
*.vbproj merge=union
9+
*.fsproj merge=union
10+
*.dbproj merge=union
11+
12+
# Standard to msysgit
13+
*.doc diff=astextplain
14+
*.DOC diff=astextplain
15+
*.docx diff=astextplain
16+
*.DOCX diff=astextplain
17+
*.dot diff=astextplain
18+
*.DOT diff=astextplain
19+
*.pdf diff=astextplain
20+
*.PDF diff=astextplain
21+
*.rtf diff=astextplain
22+
*.RTF diff=astextplain

‎.gitignore

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
#################
2+
## SparkFun Useful stuff
3+
#################
4+
5+
## AVR Development
6+
*.eep
7+
*.elf
8+
*.lst
9+
*.lss
10+
*.sym
11+
*.d
12+
*.o
13+
*.srec
14+
*.map
15+
16+
## Notepad++ backup files
17+
*.bak
18+
19+
## BOM files
20+
*bom*
21+
22+
## VSCode directories
23+
.vscode
24+
25+
#################
26+
## Eclipse
27+
#################
28+
29+
*.pydevproject
30+
.project
31+
.metadata
32+
bin/
33+
tmp/
34+
*.tmp
35+
*.bak
36+
*.swp
37+
*~.nib
38+
local.properties
39+
.classpath
40+
.settings/
41+
.loadpath
42+
43+
# External tool builders
44+
.externalToolBuilders/
45+
46+
# Locally stored "Eclipse launch configurations"
47+
*.launch
48+
49+
# CDT-specific
50+
.cproject
51+
52+
# PDT-specific
53+
.buildpath
54+
55+
56+
#############
57+
## Eagle
58+
#############
59+
60+
# Ignore the board and schematic backup files and lock files
61+
*.b#?
62+
*.s#?
63+
*.l#?
64+
*.lck
65+
66+
67+
#############
68+
## KiCad
69+
#############
70+
71+
*cache.lib
72+
*.kicad_pcb-bak
73+
*.net
74+
*.gbr
75+
*.drl
76+
77+
78+
#################
79+
## Visual Studio
80+
#################
81+
82+
## Ignore Visual Studio temporary files, build results, and
83+
## files generated by popular Visual Studio add-ons.
84+
85+
# User-specific files
86+
*.suo
87+
*.user
88+
*.sln.docstates
89+
90+
# Build results
91+
[Dd]ebug/
92+
[Rr]elease/
93+
*_i.c
94+
*_p.c
95+
*.ilk
96+
*.meta
97+
*.obj
98+
*.pch
99+
*.pdb
100+
*.pgc
101+
*.pgd
102+
*.rsp
103+
*.sbr
104+
*.tlb
105+
*.tli
106+
*.tlh
107+
*.tmp
108+
*.vspscc
109+
.builds
110+
*.dotCover
111+
112+
## TODO: If you have NuGet Package Restore enabled, uncomment this
113+
#packages/
114+
115+
# Visual C++ cache files
116+
ipch/
117+
*.aps
118+
*.ncb
119+
*.opensdf
120+
*.sdf
121+
122+
# Visual Studio profiler
123+
*.psess
124+
*.vsp
125+
126+
# ReSharper is a .NET coding add-in
127+
_ReSharper*
128+
129+
# Installshield output folder
130+
[Ee]xpress
131+
132+
# DocProject is a documentation generator add-in
133+
DocProject/buildhelp/
134+
DocProject/Help/*.HxT
135+
DocProject/Help/*.HxC
136+
DocProject/Help/*.hhc
137+
DocProject/Help/*.hhk
138+
DocProject/Help/*.hhp
139+
DocProject/Help/Html2
140+
DocProject/Help/html
141+
142+
# Click-Once directory
143+
publish
144+
145+
# Others
146+
[Bb]in
147+
[Oo]bj
148+
sql
149+
TestResults
150+
*.Cache
151+
ClientBin
152+
stylecop.*
153+
~$*
154+
*.dbmdl
155+
Generated_Code #added for RIA/Silverlight projects
156+
157+
# Backup & report files from converting an old project file to a newer
158+
# Visual Studio version. Backup files are not needed, because we have git ;-)
159+
_UpgradeReport_Files/
160+
Backup*/
161+
UpgradeLog*.XML
162+
163+
164+
############
165+
## Windows
166+
############
167+
168+
# Windows image file caches
169+
Thumbs.db
170+
171+
# Folder config file
172+
Desktop.ini
173+
174+
175+
#############
176+
## Mac OS
177+
#############
178+
179+
.DS_Store
180+
181+
182+
#############
183+
## Linux
184+
#############
185+
186+
# backup files (*.bak on Win)
187+
*~
188+
189+
190+
#############
191+
## Python
192+
#############
193+
194+
*.py[co]
195+
196+
# Packages
197+
*.egg
198+
*.egg-info
199+
dist
200+
build
201+
eggs
202+
parts
203+
bin
204+
var
205+
sdist
206+
develop-eggs
207+
.installed.cfg
208+
209+
# Installer logs
210+
pip-log.txt
211+
212+
# Unit test / coverage reports
213+
.coverage
214+
.tox
215+
216+
#Translations
217+
*.mo
218+
219+
#Mr Developer
220+
.mr.developer.cfg

‎CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
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).

‎Documentation/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
SparkFun Documentation
2+
=======================
3+
4+
This directory should include any necessary datasheets, example number crunching, etc.

‎Enclosure/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Enclosure directory.
2+
====================
3+
4+
5+
For any 3D files/models of enclosures that are included with products.
6+
For example, the casing for the MicroView.
7+

‎Firmware/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
SparkFun <PRODUCT NAME> Firmware
2+
===================================
3+
4+
* **Examples** - <LANGUAGE> examples
5+
* <EXAMPLE NAME> - <FUNCTION>
6+
7+

‎Hardware/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
SparkFun <PRODUCT NAME> Design Files
2+
=====================================
3+
4+
The .sch and .brd files hare are Eagle CAD schematic and PCB design files from SparkFun Electronics.
5+
A freeware version of Autodesk Eagle can be found [here](https://www.autodesk.com/products/eagle/free-download).
6+

‎ISSUE_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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
17+
for any purpose, even commercially.
18+
The licensor cannot revoke these freedoms as long as you follow the license terms.
19+
Under the following terms:
20+
21+
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.
22+
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
23+
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
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 is released under the MIT License(http://opensource.org/licenses/MIT).**
34+
35+
The MIT License (MIT)
36+
37+
Copyright (c) 2016 SparkFun Electronics
38+
39+
Permission is hereby granted, free of charge, to any person obtaining a copy
40+
of this software and associated documentation files (the "Software"), to deal
41+
in the Software without restriction, including without limitation the rights
42+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
43+
copies of the Software, and to permit persons to whom the Software is
44+
furnished to do so, subject to the following conditions:
45+
46+
The above copyright notice and this permission notice shall be included in all
47+
copies or substantial portions of the Software.
48+
49+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
50+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
51+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
52+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
53+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
54+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
55+
SOFTWARE.

‎Libraries/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
SparkFun <PRODUCT NAME> Libraries
2+
=================================
3+
4+
Libraries for use in different environments.
5+
6+
7+
Directory Contents
8+
-------------------
9+
* **/Arduino** - [Arduino IDE](http://www.arduino.cc/en/Main/Software) libraries
10+
* **/Spark.io** - [Spark.io IDE](https://build.spark.io/build) libraries
11+
12+
13+
14+
Update Library Instructions:
15+
----------------------------
16+
To get the most up-to-date version of the library, you must run the following git subtree commands.
17+
18+
`$git subtree pull -P Libraries/<COMPILER NAME> --squash <product library repo URL> master`

0 commit comments

Comments
 (0)