Documentation improvements.

src/KiCadLibrary/KiCadLibrary.py

@@ -30,6 +30,39 @@ class KiCadLibrary(object):
 
     The   source   code   for   this   project   is   hosted  on
     [https://github.com/madworx/robotframework-kicadlibrary/|GitHub].
+
+    == Terminology ==
+
+    * _Module_ refers to components having been placed onto the PCB.
+    
+    * _Pads_ refers to the pads ("pins") on the modules placed on the PCB.
+    
+    * _Pins_ refers to the corresponding pin-out defined in KiCad 
+    libraries (e.g. `74xx`) for a given module.
+
+    * _Reference_ is the main identity of the component in the design,
+    such as `U1`, `R242` or `J_42`.
+
+    * _Value_ is the component type name, such as `74LS04`, `R`, 
+    `Conn_02x02_Counter_Clockwise` or `GND`.
+
+    == Finding modules ==
+    Generally, all keywords in this library uses regular expressions
+    for matching, and take a number of options as argument, namely
+    `value`, `reference` and `pad_netname`.
+
+    To ensure that all resistors in a design are placed on an even
+    50 mil grid, the following keyword could be used:
+
+    | `Module Pads Should Be On Grid` | 50 mil | value=R |
+
+    To ensure that all connectors related to the ISA-bus are on an
+    even 100 mil boundary, the following keyword could be used:
+    (Assuming that the connectors in question have the string "ISA"
+    in their component reference)
+
+    | `Module Pads Should Be On Grid` | 50 mil | value=Conn.* | reference=.*ISA.* |
+
     """
 
     ROBOT_LIBRARY_SCOPE = "GLOBAL"