@infused-kim's ergogen PCB footprints

Warning

These footprints have not been tested and are still under active development. Use them at your own risk.

1. Installation
   1. How to add the footprints as a git submodule
   2. How to use them in your ergogen config
   3. How to update the submodule
   4. How to clone your ergogen repo
2. How to design or modify ergogen footprints
3. License

Installation

How to add the footprints as a git submodule

Add the footprint library as a git submodule to your project...

git submodule add git@github.com:infused-kim/kb_ergogen_fp.git ergogen/footprints/infused-kim/

Make sure to adjust the path to a subfolder in your ergogen folder (ergogen/footprints/infused-kim/ in the example above.)

How to use them in your ergogen config

You can then use the footprints in your ergogen config.yaml:

[...]
pcbs:
    your_keyboard:
        footprints:
            # Controller
            promicro:
                what: infused-kim/nice_nano_pretty
                params:
                    traces: true
                    show_via_labels: false
[...]

How to update the submodule

To update to a newer version...

# Pull updates inside the submodule repo
cd ergogen/footprints/infused-kim/
git checkout main
git pull

# Update the submodule in the parent repo
cd ..
git add .
git commit -m "Updated infused-kim footprint submodule"

How to clone your ergogen repo

Users who clone your ergogen repo, must also update the submodule. So you should instruct them to either clone with the --recursive mode...

git clone --recursive git@github.com:your-user/your-keyboard.git

Or do init and update the submodules in a repo that was already cloned repo without the --recursive argument...

git clone git@github.com:your-user/your-keyboard.git
cd your-keyboard
git submodule init && git submodule update

Git will load exactly the same version of the footprints that you used. So you don't need to worry about accidental updates to incompatible future versions.

How to design or modify ergogen footprints

I wrote a guide on how to convert KiCad footprints to ergogen that you can find here.

If you want to modify any of the footprints here, you can find many of the original KiCad v5 footprint files I used or created in the ./kicad_footprints/ directory.

License

TLDR:

• Personal use with attribution
• Commercial use not allowed

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.