Readme file updates

General clean-up and improvement update: fix a few mistakes, add the Nano Every to the list of included modules, change terminology to be more internally consistent, and update the licensing section with more and clearer information.

Author: Alarm-Siren

README.md

@@ -1,51 +1,56 @@
-# Arduino KiCad Library
+# KiCad Symbol & Footprint Library for Arduino modules
 *Version 2.3.0*
 
-Library of schematic components and footprints of common Arduino boards for KiCad.
+This is a library of KiCad schematic symbols and PCB footprints for common Arduino modules. You can use them to make your own PCB design which will effortlessly connect with your chosen Arduino module.
 
-Currently included are:
+Currently included modules:
 - Arduino 101 Shield
 - Arduino Due Shield
-- Arduino Leonardo Shied
+- Arduino Leonardo Shield
 - Arduino M0 Shield
 - Arduino M0 Pro Shield
 - Arduino Mega 2560 Shield
 - Arduino Micro Socket
 - Arduino Mini Socket
 - Arduino MKR Zero Socket
-- Arduino MKR 1000 WiFi
-- Arduino MKR WiFi 1010
-- Arduino MKR FOX 1200
-- Arduino MKR WAN 1300
-- Arduino MKR WAN 1310
-- Arduino MKR GSM 1400
-- Arduino MKR NB 1500
-- Arduino MKR Vidor 4000
+- Arduino MKR 1000 WiFi Socket
+- Arduino MKR WiFi 1010 Socket
+- Arduino MKR FOX 1200 Socket
+- Arduino MKR WAN 1300 Socket
+- Arduino MKR WAN 1310 Socket
+- Arduino MKR GSM 1400 Socket
+- Arduino MKR NB 1500 Socket
+- Arduino MKR Vidor 4000 Socket
 - Arduino Nano Socket
+- Arduino Nano Every SMD
+- Arduino Nano Every Socket
 - Arduino Pro Mini Socket
 - Arduino Uno R3 Shield
 - Arduino Uno R3 SMD Shield
 - Arduino Uno WiFi R2 Shield
 - Arduino Zero Shield
 - Pro Mini Clone Socket
 
-Shield means the Arduino is designed to plug in from beneath your PCB; socket means it is designed to plug in from above.
+*"Shield" means the module is designed to plug in from beneath your PCB. "Socket" means the module is designed to plug in from above your PCB. "SMD" means the module is designed to be soldered directly on to your PCB using surface-mount pads.*
 
 ## Compatibility with KiCad 5
 This library is in the new KiCad 6 "S-Expressions" format, and is not compatible with KiCad 5. If you need compatibility with KiCad 5, please use version 1.4.1 of this repository - but be aware that said version does not contain all features and is not being maintained.
 
 ## Comments, Requests, Bugs & Contributions
 All are welcome!
-Please file 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.
+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.
 
-## License
-Copyright 2017-2022, [Nicholas Parks Young](https://github.com/Alarm-Siren). All Rights Reserved.  
+## Legal Information & License
+Copyright 2017-2022, [Nicholas Parks Young](https://github.com/Alarm-Siren). All Rights Reserved.
 
-This work is licensed under a
-[Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).
+Except as otherwise noted, the content of this library is licensed under the 
+[Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/), with the following exception:
+> To the extent that the creation of electronic designs that use Licensed Material can be considered to be Adapted Material, the Licensor waives Section 3 of the Public License with respect to these electronic designs and any generated files which use data provided as part of the Licensed Material.
 
 [![CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](https://creativecommons.org/licenses/by-sa/4.0/)
 
+The word "Arduino" is a registered trademark of Arduino SA. This trademark is used in this library to refer to Arduino products and to identify Arduino-related non-commercial content, as permitted by Arduino's [trademark guidelines](https://www.arduino.cc/en/trademark). This project is not affiliated with nor endorsed by Arduino.
+
 ## Donations
 
 If you've found this library useful and you'd like to make a donation towards its continued upkeep, click the button below:
@@ -72,21 +77,21 @@ To add this library to your KiCad Project, do the following steps:
 ## A note about Power and Reset pins
 
 ### Power
-On the Arduino Platform, it is not possible to categorically state that the power pins are "power inputs" or "power outputs", as that depends on exactly how you're using the Arduino. For example, if you're powering the Arduino from USB then GND, +3.3V and +5V would be power outputs and VIN would do nothing, whereas if you're powering the Arduino from a battery via your Shield then VIN and GND are power inputs whilst +5V and +3.3V are power outputs. There are other, more esoteric possibilities too.
+On Arduino modules, it is not possible to categorically state that the power pins are "power inputs" or "power outputs", as that depends on exactly how you're using the module in your design. For example, if you're powering the module from the USB connector then GND, +3.3V and +5V would be power outputs and VIN would do nothing, whereas if you're powering the module from a battery via your PCB then VIN and GND are power inputs whilst +5V and +3.3V are power outputs. There are other, more esoteric possibilities too.
 
-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.
+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 okay in some situations.
 
-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 the special "PWR_FLAG" component to the affected net.
+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 design, by default the ERC will complain that the relevant nets are undriven. To fix this you will need to add the special "PWR_FLAG" component to the affected net.
 
-NOTE: As of version 2.0.0, on the 5V-based Arduino boards the 3.3V output pin has been changed to Power Output, as these will be powered by an on-board regulator and should not have external power fed into them.
+*Note: as of version 2.0.0, on 5V-based modules the +3.3V output pin has been changed to "power output", as these will be powered by an on-board regulator and should not have external power fed into them.*
 
 ### 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.
+Reset pins on Arduino modules 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 Arduino modules have an internal weak pull-up and a reset button that can strongly pull low, so your design needs to be able to cope with all these situations.
 
-In other words, if you use the reset pin as an input to your shield then you do not need to add a pull-up (doing so will actually make it less responsive if not break it); conversely if you want to drive the reset line in order to reset the Arduino you need to ensure that you only ever pull it low - if you pull it high at the same time as an unwitting user hits the physical reset button, you've created a short between power and ground which will likely fry whatever chip is on your shield.
+In other words, if you use the reset pin as an input to your PCB then you do not need to add a pull-up (doing so will actually make it less responsive if not break it); conversely if you want to drive the reset line in order to reset the module from your PCB, you need to ensure that you only ever pull it low: if you pull it high at the same time as an unwitting user hits the physical reset button, you've created a short between power and ground which will likely fry whatever chip is on your PCB.
 
 ### TL;DR:
 
-*The KiCad ERC cannot catch all the possible electrical errors on your schematic as it doesn't natively support the reset and power pins' electrical types. Even if the ERC says its OK, double check it manually.*
+*The KiCad ERC cannot catch all the possible electrical errors on your design as it doesn't natively support the reset and power pins' electrical types. Even if the ERC says its OK, double check it manually.*
 
 *If the ERC says that your power pins are undriven, first manually check they are being driven. If they are driven, then add a "PWR_FLAG" component to the net to make the error go away.*