Added documentation for switch footprints

package-lock.json

@@ -5,6 +5,7 @@
     "requires": true,
     "packages": {
         "": {
+            "name": "ergogen",
             "version": "2.0.0",
             "license": "MIT",
             "dependencies": {

src/footprints/choc.js

@@ -7,6 +7,8 @@
 //      if true, will include holes and pads for Kailh choc hotswap sockets
 //    reverse: default is false
 //      if true, will flip the footprint such that the pcb can be reversible
+//    keycaps: default is false
+//      if true, will add choc sized keycap box around the footprint
 // 
 // note: hotswap and reverse can be used simultaneously
 
@@ -44,13 +46,13 @@ module.exports = {
       (pad "" np_thru_hole circle (at 5.5 0) (size 1.7018 1.7018) (drill 1.7018) (layers *.Cu *.Mask))
       (pad "" np_thru_hole circle (at -5.5 0) (size 1.7018 1.7018) (drill 1.7018) (layers *.Cu *.Mask))
       `
-      const keycap = `
+    const keycap = `
-        ${'' /* keycap marks */}
+      ${'' /* keycap marks */}
-        (fp_line (start -9 -8.5) (end 9 -8.5) (layer Dwgs.User) (width 0.15))
+      (fp_line (start -9 -8.5) (end 9 -8.5) (layer Dwgs.User) (width 0.15))
-        (fp_line (start 9 -8.5) (end 9 8.5) (layer Dwgs.User) (width 0.15))
+      (fp_line (start 9 -8.5) (end 9 8.5) (layer Dwgs.User) (width 0.15))
-        (fp_line (start 9 8.5) (end -9 8.5) (layer Dwgs.User) (width 0.15))
+      (fp_line (start 9 8.5) (end -9 8.5) (layer Dwgs.User) (width 0.15))
-        (fp_line (start -9 8.5) (end -9 -8.5) (layer Dwgs.User) (width 0.15))
+      (fp_line (start -9 8.5) (end -9 -8.5) (layer Dwgs.User) (width 0.15))
-        `
+      `
     function pins(def_neg, def_pos, def_side) {
       if(p.param.hotswap) {
         return `

src/footprints/chocmini.js

@@ -5,6 +5,8 @@
 // Params
 //    reverse: default is false
 //      if true, will flip the footprint such that the pcb can be reversible 
+//    keycaps: default is false
+//      if true, will add choc sized keycap box around the footprint
 
 module.exports = {
     nets: ['from', 'to'],
@@ -20,7 +22,7 @@ module.exports = {
         ${p.at /* parametric position */} 
 
         ${'' /* footprint reference */}        
-        (fp_text reference REF** (at 0 7.4) (layer F.Fab) (effects (font (size 1 1) (thickness 0.15))))
+        (fp_text reference "${p.ref}" (at 0 0) (layer F.SilkS) ${p.ref_hide} (effects (font (size 1.27 1.27) (thickness 0.15))))
         (fp_text value Kailh_PG1232 (at 0 -7.3) (layer F.Fab) (effects (font (size 1 1) (thickness 0.15))))
 
         ${'' /* corner marks */}

src/footprints/mx.js

@@ -7,6 +7,8 @@
 //      if true, will include holes and pads for Kailh MX hotswap sockets
 //    reverse: default is false
 //      if true, will flip the footprint such that the pcb can be reversible 
+//    keycaps: default is false
+//      if true, will add choc sized keycap box around the footprint
 //
 // note: hotswap and reverse can be used simultaneously