diff --git a/README.md b/README.md index fbdc0f8..be14c38 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,13 @@ Currently included are: Shield means the Arduino is designed to plug in from beneath your PCB; socket means it is designed to plug in from above. +## Comments, Requests, Bugs & Contributions +All are welcome. Please file an Issue or Pull Request at https://github.com/Alarm-Siren/arduino-kicad-library + +## License +Copyright 2017, Nicholas Parks Young. Some Rights Reserved. +This library is licensed under the GNU LGPL v2.1, which can be found in file LICENSE.txt. + ## Library Setup To add this library to your KiCad Project, do the following steps: 1. Copy the source files to your Project. Make sure that the Arduino.pretty folder structure is preserved. @@ -25,13 +32,6 @@ To add this library to your KiCad Project, do the following steps: 7. In the new line of the table, set Library Path to "$(KIPRJMOD)\Arduino.pretty" and ensure Plugin Type is "KiCad". Options and Description can be left blank. You should set Nickname to something descriptive - like "Arduino" for example! 8. All done: you are now ready to use these schematic components and footprints! -## Comments, Requests, Bugs & Contributions -All are welcome. Please file an Issue or Pull Request at https://github.com/Alarm-Siren/arduino-kicad-library - -## License -Copyright 2017, Nicholas Parks Young. Some Rights Reserved. -This library is licensed under the GNU LGPL v2.1, which can be found in file LICENSE.txt. - ## A note about Power and Reset pins ### Power @@ -39,7 +39,7 @@ On the Arduino Platform, it is not possible to categorically state that the powe Regardless of the above, I needed to make a decision about what electrical type to apply to these pins. I could use something like Passive or Unspecified, but then KiCad's Electrical Rules Checker (ERC) tool would not be effective in catching errors on these pins at all, whilst using Power Output means it objects to you joining pins together (for example, joining all the GND pins into a common net) even when that's OK in some situations. -Therefore, I have decided to use Power Input as this presents the least issues. +Therefore, I have decided to use Power Input as this presents the least issues. This means if you're actually using any of the power pins as Power Outputs in your schematic, by default the ERC will complain that the relevant nets are undriven. To fix this you will need to add a special "PWR_FLAG" component to the affected net. ### Reset Reset pins on the Arduino Platform have interesting electrical characteristics, which mean that no KiCad electrical type exactly matches their functionality. I settled on Open Collector as the nearest candidate, but unlike a true Open Collector pin on an integrated circuit, the reset pins on the Arduino Platform have an internal weak pull-up, and the reset button that can strongly pull low, so your circuit needs to be able to cope with all these situations.