Skip to content

Commit 7b3324e

Browse files
committed
Update README and metadata
1 parent 6a50949 commit 7b3324e

File tree

3 files changed

+48
-20
lines changed

3 files changed

+48
-20
lines changed

README.md

Lines changed: 42 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
SparkFun Electronics KiCad Libraries
22
====================================
33

4-
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.
4+
This repository contains the SparkFun KiCad Libraries 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 these libraries have errors. Please report any issues! We'll fix them quickly.
55

66
![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

1010
## Theory
1111

12-
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!
12+
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 these libraries 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

14-
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.
14+
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 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

@@ -26,21 +26,47 @@ We use the following naming conventions to create our 'bubble gum' parts:
2626

2727
## Installing and using these libraries
2828

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.
29+
* [Installing a release via the KiCad PCM](#installing-a-release-via-the-kicad-pcm)
30+
* [Installing a release from zip file - without the PCM_ Library nickname prefix](#installing-a-release-from-zip-file---without-the-pcm_-library-nickname-prefix)
31+
* [Download the current libraries as a zip file](#download-the-current-libraries-as-a-zip-file)
32+
* [Using Git](#using-git)
3033

31-
### Download ZIP
34+
### Installing a release via the KiCad PCM
3235

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 KiCad **Symbol Editor** and select `Preferences \ Configure Paths`. Add a new Environmental Variable called `SPARKFUN_KICAD_LIBRARY` and set the Path to the `SparkFun-KiCad-Libraries` folder :
36+
From the fall of 2025, releases of these libraries are available via the KiCad Plugin and Content Manager (PCM).
37+
38+
Open the PCM, select the "Libraries" tab, and type "SparkFun" into the search box. The "Install" button will install the latest release of the libraries.
39+
40+
Note: this method assumes you have the KiCad Library nickname prefix set to the default of 'PCM_'. If you have cleared the Library nickname prefix, use the [next option](#installing-a-release-from-zip-file---without-the-pcm_-library-nickname-prefix) to install from zip file.
41+
42+
### Installing a release from zip file - without the PCM_ Library nickname prefix
43+
44+
In the KiCad Preferences, you will find settings for "Packages and Updates". The "Library nickname prefix" is applied to any libraries installed through the Plugin and Content Manager (PCM).
45+
46+
![Library nickname prefix](./img/PCM_prefix.png)
47+
48+
If you install these libraries trhough the PCM, the installation assumes the prefix is 'PCM_'. The symbol footprint names will all be prefixed with 'PCM_'. If you have cleared the prefix, you will need to manually install a different version of the libraries without the footprint prefix:
49+
50+
* Navigate to the libraries [Releases page](https://github.com/sparkfun/SparkFun-KiCad-Libraries/releases)
51+
* You will find two zip file "Assets" attached to each release
52+
* Download the **"without-pcm"** zip file
53+
* In the PCM, use the "Install from File..." option to install the zip file
54+
55+
If you are changing the Library prefix to use this installation method, we recommend: clearing the prefix, OK the changes, **close KiCad** and reopen before installing the zip file.
56+
57+
### Download the current libraries as a zip file
58+
59+
Instead of waiting for a release, you can download a copy of the libraries at any time 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 KiCad **Symbol Editor** and select `Preferences \ Configure Paths`. Add a new Environmental Variable called `SPARKFUN_KICAD_LIBRARY` and set the Path to the `SparkFun-KiCad-Libraries` folder :
3460

3561
![SPARKFUN_KICAD_LIBRARY Environment Variable](./img/Environment_Variable.png)
3662

37-
Then select `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 `SparkFun-.kicad_sym` symbol files and click `Open` :
63+
Then select `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 `SparkFun-.kicad_sym` symbol files and click `Open` :
3864

3965
![Adding the symbols](./img/Add_Symbols.png)
4066

4167
![Added symbols](./img/Added_Symbols.png)
4268

43-
Then likewise in the **Footprint Editor**, select `Preferences \ Manage Footprint Libraries`. Click the folder button to "Add existing (KiCad folder)". Navigate to the `SparkFun-KiCad-Libraries \ Footprints` folder, select everything except the `3D-Models` folder (Strictly, that one is in the wrong place. Sorry about that) and click `Select Folder` :
69+
Then likewise in the **Footprint Editor**, select `Preferences \ Manage Footprint Libraries`. Click the folder button to "Add existing (KiCad folder)". Navigate to the `SparkFun-KiCad-Libraries \ footprints` folder, select everything and click `Select Folder` :
4470

4571
![Adding the footprints](./img/Add_Footprints.png)
4672

@@ -50,25 +76,26 @@ Then likewise in the **Footprint Editor**, select `Preferences \ Manage Footprin
5076

5177
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.
5278

53-
Again, add the Symbols and Footprints Paths as described in the previous section.
79+
Again, add the Symbols and Footprints Paths as described in the [previous section](#download-the-current-libraries-as-a-zip-file).
5480

55-
If you use the "Watch All Activity" option above, you will be notified each time we Push changes in the libraries. You can then Pull the changes to stay completely up to date. (It's what we do!)
81+
If you use the "Watch All Activity" option above, you will be notified each time we Push changes in the libraries. You can then Pull the changes to stay completely up to date. (It's what we do at SparkFun!)
5682

5783
Contents
5884
-------------------
5985

60-
* [/Footprints](https://github.com/sparkfun/SparkFun-KiCad-Libraries/tree/main/Footprints) -- PCB footprints
61-
* [/Symbols](https://github.com/sparkfun/SparkFun-KiCad-Libraries/tree/main/Symbols) -- Schematic symbols
86+
* [/symbols](https://github.com/sparkfun/SparkFun-KiCad-Libraries/tree/main/symbols) -- Schematic symbols
87+
* [/footprints](https://github.com/sparkfun/SparkFun-KiCad-Libraries/tree/main/footprints) -- PCB footprints
88+
* [/3dmodels/3d-library.3dshapes](https://github.com/sparkfun/SparkFun-KiCad-Libraries/tree/main/3dmodels/3d-library.3dshapes) -- 3D models - usually in step format
6289

6390
License
6491
-------------------
6592

66-
This library is released under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) license.
67-
**You are welcome to use this library for commercial purposes.**
93+
This libraries are released under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) license.
94+
**You are welcome to use these libraries for commercial purposes.**
6895
For attribution, we ask that when you begin to sell your device using our footprint, you email us with a link to the product being sold.
6996
We want bragging rights that we helped (in a very small part) to create your 8th world wonder.
7097
We would like the opportunity to feature your device on our homepage.
7198

72-
Please consider contributing back to this library or others to help the open-source hardware community continue to thrive and grow!
99+
Please consider contributing back to these libraries or others to help the open-source hardware community continue to thrive and grow!
73100

74101
- Your friends at SparkFun

img/PCM_prefix.png

34.3 KB
Loading

pcm/metadata_template.json

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22
"$schema": "https://go.kicad.org/pcm/schemas/v1",
33
"name": "SparkFun KiCad Libraries",
44
"description": "SparkFun's Libraries for KiCad 7 / 8 / 9",
5-
"description_full": "This library contains SparkFun's commonly used parts. It is a cultivated combination of KiCad stock parts, SparkFun-unique footprints, and open-source 3D models.",
5+
"description_full": "This library contains SparkFun's commonly used parts.\nIt is a cultivated combination of KiCad stock parts, SparkFun-unique footprints, and open-source 3D models.\n\nCheck your settings in Preferences -> Packages and Updates.\nIf you have the default Library nickname prefix 'PCM_', you can proceed to install the libraries through the PCM.\nIf you don't want that prefix, leave that field blank and install the libraries from zip file instead.\nThe installation link below has more details.",
66
"identifier": "com.github.sparkfun.SparkFun-KiCad-Libraries",
77
"type": "library",
8+
"license": "CC-BY-4.0",
9+
"resources": {
10+
"homepage": "https://github.com/sparkfun/SparkFun-KiCad-Libraries",
11+
"installation": "https://github.com/sparkfun/SparkFun-KiCad-Libraries#installing-and-using-these-libraries"
12+
},
813
"author": {
914
"name": "SparkFun",
1015
"contact": {
@@ -21,10 +26,6 @@
2126
"twitter": "https://twitter.com/sparkfun"
2227
}
2328
},
24-
"license": "CC-BY-4.0",
25-
"resources": {
26-
"homepage": "https://github.com/sparkfun/SparkFun-KiCad-Libraries"
27-
},
2829
"versions": [
2930
{
3031
"version": "9.0.0",

0 commit comments

Comments
 (0)