.gitignore

@@ -5,3 +5,4 @@
 *.FCStd1
 kicad-library-utils
 test-project
+*.FCBak

.gitlab-ci.yml

-# This file tests integrity of libraries in this repository
-# Created by Krisjanis Rijnieks on 2 May 2020
-
 image: python:latest
 
 before_script:
   - apt update && apt install -y jq
-  - python -V
-  - jq --version
   - git clone --depth=1 https://gitlab.com/kicad/libraries/kicad-library-utils
 
-test:
-  script:
-    - ./tests/inventory.sh ./fab.kicad_sym ./tests/whitelist.txt
-    - ./tests/symbols.sh
+stages:
+  - stage_test_inventory
+  - stage_test_footprints
+  - stage_test_3dmodels
+
+test_inventory:
+  stage: stage_test_inventory
+  script: |
+    echo "Do we have all parts in inventory covered?"
+    ./tests/inventory.sh ./fab.kicad_sym ./tests/whitelist.txt
+
+test_footprints:
+  stage: stage_test_footprints
+  script: |
+    echo "TODO: Do we have footprints for all symbols?"
+
+test_3dmodels:
+  stage: stage_test_3dmodels
+  script: |
+    echo "TODO: Do we have 3D models for all footprints?"

README.md

@@ -2,21 +2,28 @@
 
 [![all tests](https://gitlab.fabcloud.org/pub/libraries/electronics/kicad/badges/master/pipeline.svg?key_text=all+tests&key_width=60)](https://gitlab.fabcloud.org/pub/libraries/electronics/kicad/-/commits/master)
 
-> **What about KiCad 8?** Yes, it is KiCad 8 compatible!
+> **What about KiCad 8?** Yes, it is KiCad 8 compatible.
 
-This library includes all the electronics components listed in the official [Fab Inventory](http://inventory.fabcloud.io/). 
+> **It does not work on KiCad 7!** Yes, sorry, it is easier to maintain the library with latest KiCad. Please install KiCad 8.
+
+This library includes all the electronics components listed in the official [Fab Inventory](http://inventory.fabcloud.io/).
 
 > **Warning!** the library is under active development. Naming of components can change overnight. Make sure to `git pull` the latest version before doing work.
 
 ## Installation
 
-> Make sure you have at least **KiCad 7** or greater installed. It works fine with **Kicad 8**.
+> Make sure you have at least **KiCad 8** or greater installed.
 
-1. Clone or download this repository. You may rename the directory to `fab`.
+1. Clone or download this repository. You **should** rename the directory to `fab`.
 2. Store it in a safe place such as `~/kicad/libraries` or `C:/kicad/libraries`.
 3. Run KiCad or open a KiCad `.pro` file.
-4. Go to "Preferences / Manage Symbol Libraries" and add `fab.kicad_sym` as symbol library.
-5. Go to "Preferences / Manage Footprint Libraries" and add `fab.pretty` as footprint library.
+4. Go to "Preferences / Configure Paths" and add new environment variable "FAB" that points to location of the fab library on your drive, e.g. `~/kicad/libraries/fab`. This is needed for the 3D models to load correctly.
+5. Go to "Preferences / Manage Symbol Libraries" and add `fab.kicad_sym` as symbol library.
+6. Go to "Preferences / Manage Footprint Libraries" and add `fab.pretty` as footprint library.
+
+## Note on modules
+
+Symbols and footprints of breakout boards (such as [DFRobot DFR0299](https://www.digikey.com/en/products/detail/dfrobot/DFR0299/6588463) or [Adafruit 3006](https://www.digikey.com/en/products/detail/adafruit-industries-llc/3006/6058477)) are not added to this library. Use plain pin-headers or pin-sockets for them in your design. Most of them have headers with 2.54mm (0.1inch) pitch and available drawings with dimensions available. As this library is made for teaching purposes, take this as an exercise.
 
 ## ToDo