Skip to content

Commit cb75355

Browse files
committed
Added formatting for arduino library
1 parent 98e05cb commit cb75355

File tree

3 files changed

+288
-0
lines changed

3 files changed

+288
-0
lines changed

.gitignore

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

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 platform are you using?
6+
* What version of the device are you using? Is there a firmware version?
7+
* How is the device wired to your platform?
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 to a gist.
13+
14+
### Expected behaviour
15+
Tell us what should happen
16+
17+
### Actual behaviour
18+
Tell us what happens instead

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
SparkFun <PRODUCT NAME>
2+
========================================
3+
4+
![SparkFun Part Name](URL for picture of part)
5+
6+
[*SparkFun Part Name (SKU)*](URL for product on Sparkfun.com)
7+
8+
<Basic description of the part.>
9+
10+
Repository Contents
11+
-------------------
12+
13+
* **/Documentation** - Data sheets, additional product information
14+
* **/Enclosure** - Enclosure files
15+
* **/Firmware** - Example code
16+
* **/Hardware** - Eagle design files (.brd, .sch)
17+
* **/Libraries** - Libraries for use with the <PRODUCT NAME>
18+
* **/Production** - Production panel files (.brd)
19+
* **/Software** - Related software for the <PRODUCT NAME>
20+
21+
Documentation
22+
--------------
23+
* **[Library](GitHub library URL)** - <LANGUAGE> library for the <PRODUCT NAME>.
24+
* **[Hookup Guide](Learn.SparkFun URL)** - Basic hookup guide for the <PRODUCT NAME>.
25+
* **[SparkFun Fritzing repo](https://github.com/sparkfun/Fritzing_Parts)** - Fritzing diagrams for SparkFun products.
26+
* **[SparkFun 3D Model repo](https://github.com/sparkfun/3D_Models)** - 3D models of SparkFun products.
27+
* **[SparkFun Graphical Datasheets](https://github.com/sparkfun/Graphical_Datasheets)** -Graphical Datasheets for various SparkFun products.
28+
29+
Product Versions
30+
----------------
31+
* [Part SKU](part URL)- Basic part and short description here
32+
* [Retail part SKU](retail URL)- Retail packaging of standard description here
33+
* [Any other parts this repo covers](any other URLs) - Description of said parts
34+
35+
Version History
36+
---------------
37+
* [vExxFxxZxxHxxLxxSxx](URL for tag specific to this version) - Description
38+
* [vEyyFyyZyyHyyLyySyy](URL for tag specific to this version) - Description
39+
40+
License Information
41+
-------------------
42+
43+
This product is _**open source**_!
44+
45+
Please review the LICENSE.md file for license information.
46+
47+
If you have any questions or concerns on licensing, please contact technical support on our [SparkFun forums](https://forum.sparkfun.com/viewforum.php?f=152).
48+
49+
Distributed as-is; no warranty is given.
50+
51+
- Your friends at SparkFun.
52+
53+
_<COLLABORATION CREDIT>_

0 commit comments

Comments
 (0)