Skip to content

Commit d8036d1

Browse files
committed
Update README - add installing and using
1 parent 84b3109 commit d8036d1

9 files changed

+88
-3
lines changed

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) 2012 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.

README.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ SparkFun Electronics KiCad Libraries
33

44
This repository contains the SparkFun KiCad Library of commonly used parts. It is a cultivated combination of KiCad stock parts, SparkFun-unique footprints, and open-source 3D models. The main branch is generally proven out but we apologize in advance if this library has errors. Please report any issues! We'll fix them quickly.
55

6-
![alt text](SparkFun_GNSS_LG290P_Breakout_3D.png)
6+
![SparkFun LG290P Breakout 3D](./img/SparkFun_GNSS_LG290P_Breakout_3D.png)
77

88
**Note:** The SparkFun KiCad components contain internal part numbers (**PROD_ID-\***) for ease of manufacture for the SparkFun SMD lines.
99

10-
### Theory
10+
## Theory
1111

1212
KiCad is very good and has a large number of industry specified symbols and footprints. SparkFun has a large number of unique parts and components created since 2002. Rather than converting all previous [SparkFun Eagle libraries](https://github.com/sparkfun/SparkFun-Eagle-Libraries) to KiCad, we are adding new parts to this library as we need them for new projects. This gives us the opportunity to clear out old badness, but opens the door to new badness (ie, incorrect footprints) so reader beware!
1313

1414
The SparkFun approach: when a new part needs to be added we decide whether to use a KiCad stock symbol, edit it for use, or create it from scratch. We give preference to the stock KiCad symbol. We give heavy preference to using the original SparkFun footprint, but look at the stock KiCad footprint for inspiration as well. We'll try to follow the [KiCad Library Conventions](https://klc.kicad.org/) where it makes sense.
1515

1616
Additionally, SparkFun needs to assign various unique manufacturing data (ie, internal part numbers) to parts. To alleviate this, there is a large number of components with an identical symbol each with their own production ID information. For example, capacitors:
1717

18-
![List of SparkFun capacitors in KiCad](Capacitor-List.png)
18+
![List of SparkFun capacitors in KiCad](./img/Capacitor-List.png)
1919

2020
We use the following naming conventions to create our 'bubble gum' parts:
2121

@@ -24,6 +24,36 @@ We use the following naming conventions to create our 'bubble gum' parts:
2424
* [inductance]\_[size]\_[max current]
2525
* [led color]\_[size]\_[wavelength optional]
2626

27+
## Installing and using these libraries
28+
29+
The structure of these libraries is close to, but does not conform to the [KiCad Content libraries structure](https://dev-docs.kicad.org/en/addons/#_content_libraries). For that reason, you won't currently find these libraries in the KiCad Plugin and Content Manager.
30+
31+
### Download ZIP
32+
33+
You can download a copy of the library by clicking on the big green `<> Code` button above and selecting the `Download ZIP` option. Unzip the file somewhere convenient, usually in `Documents`. Open the **Symbol Editor** and navigate to `Preferences \ Configure Paths`. Add a new Environmental Variable called `SPARKFUN_KICAD_LIBRARY` and set the Path to the `SparkFun-KiCad-Libraries` folder :
34+
35+
![SPARKFUN_KICAD_LIBRARY Environment Variable](./img/Environment_Variable.png)
36+
37+
Then navigate to `Preferences \ Manage Symbol Libraries`. Click the folder button to "Add existing library to table". Navigate to the `SparkFun-KiCad-Libraries \ Symbols` folder, select all the `SparlFun-.kicad_sym` symbol files and click `Open` :
38+
39+
![Adding the symbols](./img/Add_Symbols.png)
40+
41+
![Added symbols](./img/Added_Symbols.png)
42+
43+
Then likewise in the **Footprint Editor**, navigate to `Preferences \ Manage Footprint Libraries` and use the folder button to "Add existing (KiCad folder)`. Select everything except the `3D-Models` folder (strictly, that one is in the wrong place) and click `Open` :
44+
45+
![Adding the footprints](./img/Add_Footprints.png)
46+
47+
![Added symbols](./img/Added_Footprints.png)
48+
49+
### Using Git
50+
51+
If you're familiar with GitHub and Git / [GitHub Desktop](https://desktop.github.com/download/), you can stay completely up to date by cloning this repo.
52+
53+
Again, add the Symbols and Footprints Paths as described in the previous section.
54+
55+
If you use the "Watch All Activity" option above, you will be notified each time we Push or Merge changes in the libraries. You can then Pull the changes to stay completely up to date.
56+
2757
Contents
2858
-------------------
2959

img/Add_Footprints.png

91.8 KB
Loading

img/Add_Symbols.png

98.8 KB
Loading

img/Added_Footprints.png

73.8 KB
Loading

img/Added_Symbols.png

75.5 KB
Loading
File renamed without changes.

img/Environment_Variable.png

20 KB
Loading
File renamed without changes.

0 commit comments

Comments
 (0)