|
1 |
| -Part Name - IMA Part-123 Not a Part345 Breakout |
| 1 | +SparkFun <PRODUCT NAME> Arduino Library |
2 | 2 | ========================================
|
3 | 3 |
|
4 |
| - |
| 4 | + |
5 | 5 |
|
6 |
| -[*Part Name (SKU)*](URL for product on Sparkfun.com) |
7 |
| - |
8 |
| -Basic description of the part [The datasheet can be found here.](http://dlnmh9ip6v2uc.cloudfront.net/datasheets/Sensors/IMU/PS-MPU-9150A.pdf) |
9 |
| - |
10 |
| - |
11 |
| -This part was created in Eagle vXXX, this firmware was created in Arduino vBlahBlahBlah, etc. |
| 6 | +[*SparkFun Part Name (SKU)*](URL for product on Sparkfun.com) |
12 | 7 |
|
| 8 | +<Basic description of the library.> |
13 | 9 |
|
14 | 10 | Repository Contents
|
15 | 11 | -------------------
|
16 | 12 |
|
17 |
| -* **/Enclosure** - 3D model of an enclosure designed for this particular part |
18 |
| -* **/Firmware** - Any firmware that the part ships with, |
19 |
| -* **/Hardware** - All Eagle design files (.brd, .sch) |
20 |
| -* **/Libraries** - All Arduino libraries and board examples |
21 |
| -* **/Production** - Test bed files and production panel files |
22 |
| -* **/Software** - Any desktop based software used to work with this project. |
23 |
| -* **[Hookup guide](Learn.SparkFun URL) - Hookup guide with examples or helpful information for product |
| 13 | +* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE. |
| 14 | +* **/extras** - Additional documentation for the user. These files are ignored by the IDE. |
| 15 | +* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE. |
| 16 | +* **library.properties** - General library properties for the Arduino package manager. |
| 17 | +* **/src** - Source files for the library (.cpp, .h). |
| 18 | + |
| 19 | +Documentation |
| 20 | +-------------- |
| 21 | + |
| 22 | +* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library. |
| 23 | +* **[Product Repository](GitHub Product URL)** - Main repository (including hardware files) for the <PRODUCT NAME>. |
| 24 | +* **[Hookup Guide](Learn.SparkFun URL)** - Basic hookup guide for the <PRODUCT NAME>. |
24 | 25 |
|
25 |
| -Please note: Fritzing parts live on the [SparkFun Fritzing repo](https://github.com/sparkfun/Fritzing_Parts) |
26 |
| -Also, 3D Models of parts live in the [SparkFun 3D Model repo](https://github.com/sparkfun/3D_Models). |
| 26 | +Products that use this Library |
| 27 | +--------------------------------- |
27 | 28 |
|
28 |
| -Product Versions |
29 |
| ----------------- |
30 |
| -* [Part SKU](part URL)- Basic part and short description here |
31 |
| -* [Retail part SKU] (retail URL)- Retail packaging of standard description here |
32 |
| -* [Any other parts this repo covers](any other URLs) - Description of said parts |
| 29 | +* [Part SKU](SparkFun part URL)- Basic part and short description here |
| 30 | +* [Part SKU](SparkFun part URL)- Basic part and short description here |
33 | 31 |
|
34 | 32 | Version History
|
35 | 33 | ---------------
|
36 |
| -* [vExxFxxZxxHxxLxxSxx](URL for tag specific to this version) description |
37 |
| -* [vEyyFyyZyyHyyLyySyy](URL for tag specific to this version) description |
| 34 | + |
| 35 | +* [vExxFxxZxxHxxLxxSxx](URL for tag specific to this version) - Description |
| 36 | +* [vEyyFyyZyyHyyLyySyy](URL for tag specific to this version) - Description |
38 | 37 |
|
39 | 38 | License Information
|
40 | 39 | -------------------
|
41 |
| -The hardware is released under [Creative Commons ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/). |
42 |
| -The code is beerware; if you see me (or any other SparkFun employee) at the local, and you've found our code helpful, please buy us a round! |
| 40 | + |
| 41 | +This product is _**open source**_! |
| 42 | + |
| 43 | +The **code** is beerware; if you see me (or any other SparkFun employee) at the local, and you've found our code helpful, please buy us a round! |
| 44 | + |
| 45 | +Please use, reuse, and modify these files as you see fit. Please maintain attribution to SparkFun Electronics and release anything derivative under the same license. |
43 | 46 |
|
44 | 47 | Distributed as-is; no warranty is given.
|
45 | 48 |
|
46 |
| -_Any collaboration credit should appear here._ |
| 49 | +- Your friends at SparkFun. |
| 50 | + |
| 51 | +_<COLLABORATION CREDIT>_ |
0 commit comments