Skip to content

Commit 27cb0a6

Browse files
santaimpersonatorsantaimpersonator
committed
Initial docs setup
Initial files to setup the hookup guide
1 parent f46d6fd commit 27cb0a6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1885
-18
lines changed

‎.gitattributes‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
11
# Auto detect text files and perform LF normalization
22
* 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: 218 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,78 @@
1-
# Windows image file caches
2-
Thumbs.db
3-
ehthumbs.db
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
476

577
#KiCad Backup files
678
*.kicad_prl
@@ -13,11 +85,104 @@ fp-info-cache
1385
_autosave*
1486
\#auto_saved_files\#
1587

16-
#Eagle Backup files
17-
*.s#?
18-
*.b#?
19-
*.l#?
20-
*.lck
88+
89+
#################
90+
## Visual Studio
91+
#################
92+
93+
## Ignore Visual Studio temporary files, build results, and
94+
## files generated by popular Visual Studio add-ons.
95+
96+
# User-specific files
97+
*.suo
98+
*.user
99+
*.sln.docstates
100+
101+
# Build results
102+
[Dd]ebug/
103+
[Rr]elease/
104+
*_i.c
105+
*_p.c
106+
*.ilk
107+
*.meta
108+
*.obj
109+
*.pch
110+
*.pdb
111+
*.pgc
112+
*.pgd
113+
*.rsp
114+
*.sbr
115+
*.tlb
116+
*.tli
117+
*.tlh
118+
*.tmp
119+
*.vspscc
120+
.builds
121+
*.dotCover
122+
123+
## TODO: If you have NuGet Package Restore enabled, uncomment this
124+
#packages/
125+
126+
# Visual C++ cache files
127+
ipch/
128+
*.aps
129+
*.ncb
130+
*.opensdf
131+
*.sdf
132+
133+
# Visual Studio profiler
134+
*.psess
135+
*.vsp
136+
137+
# ReSharper is a .NET coding add-in
138+
_ReSharper*
139+
140+
# Installshield output folder
141+
[Ee]xpress
142+
143+
# DocProject is a documentation generator add-in
144+
DocProject/buildhelp/
145+
DocProject/Help/*.HxT
146+
DocProject/Help/*.HxC
147+
DocProject/Help/*.hhc
148+
DocProject/Help/*.hhk
149+
DocProject/Help/*.hhp
150+
DocProject/Help/Html2
151+
DocProject/Help/html
152+
153+
# Click-Once directory
154+
publish
155+
156+
# Others
157+
[Bb]in
158+
[Oo]bj
159+
sql
160+
TestResults
161+
*.Cache
162+
ClientBin
163+
stylecop.*
164+
~$*
165+
*.dbmdl
166+
Generated_Code #added for RIA/Silverlight projects
167+
168+
# Backup & report files from converting an old project file to a newer
169+
# Visual Studio version. Backup files are not needed, because we have git ;-)
170+
_UpgradeReport_Files/
171+
Backup*/
172+
UpgradeLog*.XML
173+
174+
175+
# =========================
176+
# Operating System Files
177+
# =========================
178+
179+
############
180+
## Windows
181+
############
182+
183+
# Windows image file caches
184+
Thumbs.db
185+
ehthumbs.db
21186

22187
# Folder config file
23188
Desktop.ini
@@ -31,24 +196,63 @@ $RECYCLE.BIN/
31196
*.msm
32197
*.msp
33198

34-
# =========================
35-
# Operating System Files
36-
# =========================
37-
38-
# OSX
39-
# =========================
199+
#############
200+
## Mac OS
201+
#############
40202

41203
.DS_Store
204+
205+
# OSX
206+
# ===========
42207
.AppleDouble
43208
.LSOverride
44209

210+
#############
211+
## Linux
212+
#############
213+
214+
# backup files (*.bak on Win)
215+
*~
216+
217+
218+
#############
219+
## Python
220+
#############
221+
222+
*.py[co]
223+
224+
# Packages
225+
*.egg
226+
*.egg-info
227+
dist
228+
build
229+
eggs
230+
parts
231+
bin
232+
var
233+
sdist
234+
develop-eggs
235+
.installed.cfg
236+
45237
# Icon must ends with two \r.
46238
Icon
47239

240+
# Installer logs
241+
pip-log.txt
242+
243+
# Unit test / coverage reports
244+
.coverage
245+
.tox
48246

49247
# Thumbnails
50248
._*
51249

250+
#Translations
251+
*.mo
252+
52253
# Files that might appear on external disk
53254
.Spotlight-V100
54255
.Trashes
256+
257+
#Mr Developer
258+
.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).

‎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: 43 additions & 0 deletions
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) 2024 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)