Squashed 'lib/asymworks/' content from commit eacbe15

git-subtree-dir: lib/asymworks
git-subtree-split: eacbe15c14a66380e51c43426bcd2588b10c90d4

README.md

@@ -0,0 +1,29 @@
+# Asymworks KiCad Library
+
+## Usage
+The recommended way to use this library is with `git subtree` into an `asymworks` folder under the current project, and reference it as a Project Library from KiCad.
+
+```sh
+git remote add -f asymworks-library https://git.asymworks.com/asymworks/kicad-library.git
+git subtree add --prefix ./asymworks asymworks-library main --squash
+```
+
+Add the library to KiCad relative to the `${KIPRJMOD}` variable.
+
+> [!NOTE]
+> The Asymworks library currently has a mix of path specs for 3D models, most of which still use the legacy `${KICAD_USER_TEMPLATE_DIR}/asymworks-kicad-library` root rather than `${KIPRJMOD}/asymworks`. Manual intervention to change the path within `pcbnew` may be required for 3D models to show up correctly.
+
+The library can be modified from the local project directory, and changes committed back to the main repository, using a similar syntax.
+
+```sh
+git add ./asymworks
+git commit -m 'feat: added footprints XXXX'
+git subtree push --prefix ./asymworks asymworks-library main
+```
+
+> [!WARNING]
+> When using `git subtree` ensure that only changes within the subtree are added to a particular commit. Mixing files in a single commit between subtree and main project files may break things.
+
+## Useful Links
+[KiCad Library Conventions](https://klc.kicad.org)
+