Skip to content

Commit 47368d6

Browse files
committed
Update README instructions
Update README instructions to describe how to install using the native KiCad Package Manager.
1 parent b3f5a96 commit 47368d6

File tree

2 files changed

+80
-62
lines changed

2 files changed

+80
-62
lines changed

README.md

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,41 @@ This library requires at least KiCad 6 to function, and is tested on version 6.0
5050
All are welcome!
5151
Please open an [Issue](https://github.com/Alarm-Siren/arduino-kicad-library/issues) or [Pull Request](https://github.com/Alarm-Siren/arduino-kicad-library/pulls), as appropriate.
5252

53+
## Library Installation
54+
To add this library to your KiCad Project, do the following steps:
55+
56+
### Manual Download
57+
1. Go to the [releases page](https://github.com/Alarm-Siren/arduino-kicad-library/releases) and download the most recent version of the "arduino-kicad-library-x.x.x.zip" file.
58+
2. Open KiCad and click the "Plugin and Content Manager" button.
59+
3. Click "Install from File..."
60+
4. Navigate to and open the file you downloaded in step 1 using the "Choose package file" dialogue that has just opened.
61+
5. You should now find that this library is listed in the "Installed" tab.
62+
6. Go to step 7 under the KiCad PCM Download section below to complete installation.
63+
64+
### KiCad PCM Download (recommended)
65+
1. Open KiCad and click the "Plugin and Content Manager" button.
66+
2. Select the "KiCad official repository" from the top drop-down box (if not already selected).
67+
3. Go the Libraries tab and locate the "KiCad Library for Arduino Modules" in the list.
68+
4. Click the "Install" button for that entry in the list.
69+
5. Click "Apply Changes".
70+
6. You should now find that this library is listed in the "Installed" tab.
71+
7. Close the Plugin and Content Manager.
72+
8. Go to the "Preferences" -> "Manage Symbol Libraries..." menu option.
73+
9. In the Symbol Libraries dialogue that appears, switch to the "Global Libraries" tab (if not already selected).
74+
10. Click "Add empty row to table" button (the button with a big cross in it, beneath the table).
75+
11. In the new line of the table, set the Nickname to "arduino-library", and ensure the Library Format is set to "KiCad".
76+
12. In the same line of the table, set Library Path to "${KICAD6_3RD_PARTY}/symbols/com_github_alarm-siren_arduino-kicad-library/arduino-library.kicad_sym".
77+
13. Click "OK" to close the Symbol Libraries dialogue.
78+
14. Go to "Preferences" -> "Manage Footprint Libraries..." menu option.
79+
15. In the Footprint Libraries dialogue that appears, switch to the "Global Libraries" tab (if not already selected).
80+
16. Click "Add empty row to table" button (the button with a big cross in it, beneath the table).
81+
17. In the new line of the table, set the Nickname to "arduino-library", and ensure the Library Format is set to "KiCad".
82+
18. In the same line of the table, set Library Path to "${KICAD6_3RD_PARTY}/footprints/com_github_alarm-siren_arduino-kicad-library/arduino-library.pretty".
83+
19. Click "OK" to close the Footprint Libraries dialogue.
84+
20. All done: you are now ready to use these schematic components and footprints in your projects!
85+
86+
**Warning**: Do not change the Nicknames from those given in steps 11 and 17 above. If you do so KiCad will not assign the correct footprints to the symbols by default.
87+
5388
## License & Legal
5489
Copyright 2017-2023, [Nicholas Parks Young](https://github.com/Alarm-Siren).
5590

@@ -77,23 +112,6 @@ I really hope you've found this library useful. If you'd like to buy me a beer i
77112

78113
[![paypal](https://www.paypalobjects.com/en_GB/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UX25HM4CZFFWW)
79114

80-
## Library Setup
81-
To add this library to your KiCad Project, do the following steps:
82-
1. Copy the source files to the root of your KiCad project's folder. Make sure that the Arduino.pretty folder structure is preserved.
83-
2. In Schematic Editor go to "Preferences" -> "Manage Symbol Libraries..." menu option.
84-
3. In the Symbol Libraries dialogue that appears, switch to the "Project Specific Libraries" tab.
85-
4. Click "Add empty row to table" button (the button with a big cross in it, beneath the table).
86-
5. In the new line of the table, set Library Path to "${KIPRJMOD}\arduino.kicad_sym" on Windows or "${KIPRJMOD}/arduino.kicad_sym" on Linux/Mac, and ensure Plugin Type is "KiCad".
87-
6. Set Nickname to "Arduino_Library". You can leave the Options and Description fields blank.
88-
7. Close the Symbol Libraries dialogue and exit Schematic Editor.
89-
8. In PCB Editor go to "Preferences" -> "Manage Footprint Libraries..." menu option.
90-
9. In the Footprint Libraries dialogue that appears, switch to the "Project Specific Libraries" tab.
91-
10. Click "Add empty row to table" button (the button with a big cross in it, beneath the table).
92-
11. In the new line of the table, set Library Path to "${KIPRJMOD}\Arduino.pretty" on Windows or "${KIPRJMOD}/Arduino.pretty" on Linux/Mac, and ensure Plugin Type is "KiCad".
93-
12. Set Nickname to "Arduino_Library". You can leave the Options and Description fields blank.
94-
13. Close the Footprint Libraries dialogue and exit PCB Editor.
95-
14. All done: you are now ready to use these schematic components and footprints!
96-
97115
## A note about Power and Reset pins
98116

99117
### Power

0 commit comments

Comments
 (0)