Merge pull request #48 from upb-lea/test-pcb

update readme
upb-lea · Nov 21, 2024 · b359252 · b359252
2 parents 000533f + d7c71d6
commit b359252
Show file tree

Hide file tree

Showing 8 changed files with 462 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,19 @@
 This repository contains a KiCad library for symbols, footprints and 3D-models including mouser material numbers to auto-generate BOMs (bill of materials) by using [KiCost](https://github.com/hildogjr/KiCost).
 
 Features:
- * reviewed symbols and footprints trough pull-requests
- * symbols containing mouser material numbers to auto-generate a BOM using KiCost
+ * Reviewed symbols and footprints trough pull-requests,
+ * all symbols are hard linked to a footprint, this avoids miss matching symbol and footprint,
+ * symbol names follow a type code, for improved searchability,
+ * symbols containing mouser material numbers to auto-generate a BOM using [KiCost](https://github.com/hildogjr/KiCost),
+ * using KiCost together with this library can make requests to [mouser](https://eu.mouser.com/), to see if all PCB components are on stock.
+
+![](documentation/figures/symbol_linking.png)
+
+![](documentation/figures/library_examples.png)
+
+![](documentation/figures/kicost_example.png)
+
+# Install the library
 
 ## Set library file path
 Add this library to your project. Make sure that you use **exactly** the same `Nicknames` as shown here:
@@ -22,6 +33,8 @@ Replace the environment variable `MODEL_3D` with the current location of the 3D-
 Note: if there is a variable `KICADx_3DMODEL_DIR`, ignore this variable and add `MODEL_3D` as mentioned above.
 ![](documentation/figures/3d_model_path_preferences.png)
 
+# Using the library
+
 ## Adding components
 The main branch is protected. To add new components, open a new separate branch
 ```

diff --git a/documentation/figures/kicost_example.png b/documentation/figures/kicost_example.png
diff --git a/documentation/figures/kicost_example.svg b/documentation/figures/kicost_example.svg
diff --git a/documentation/figures/library_examples.png b/documentation/figures/library_examples.png
diff --git a/documentation/figures/library_examples.svg b/documentation/figures/library_examples.svg
diff --git a/documentation/figures/symbol_linking.png b/documentation/figures/symbol_linking.png
diff --git a/documentation/figures/symbol_linking.svg b/documentation/figures/symbol_linking.svg
diff --git a/sources/wordlist b/sources/wordlist
@@ -46,6 +46,7 @@ THT
 Microcontrollers
 ICs
 Schmitt
+searchability
 NetClass
 ERC
 fiducials