README (#1)

* readme

* update

.github/workflows/uniKeyPCB.yaml

@@ -0,0 +1,38 @@
+name: uniKey PCB
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+*'
+
+  workflow_dispatch:
+
+jobs:
+  KiBot-Generation:
+    runs-on: ubuntu-latest  # Don't change
+    permissions:
+      contents: write
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+
+    - name: Generate gerber for uniKey
+      uses: INTI-CMNB/[email protected]
+      with:
+        config: .kibot.yaml
+        dir: gerber
+        board: kicad/uniKeyPCB.kicad_pcb
+        schema: kicad/uniKeyPCB.kicad_sch
+
+    - name: Zip Gerber files
+      run: |
+          zip -r --junk-paths uniKeyPCB.zip gerber
+
+    - name: GH Release
+      uses: softprops/[email protected]
+      with:
+        files: "*.zip"
+        draft: true
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitmodules

@@ -1,6 +1,6 @@
 [submodule "tb2086-kicad"]
-    path=tb2086-kicad
+	path = kicad/tb2086-kicad
     url=[email protected]:Thunderbird2086/tb2086-kicad.git
 [submodule "Panelization.pretty"]
-	path = Panelization.pretty
+	path = kicad/Panelization.pretty
 	url = [email protected]:madworm/Panelization.pretty.git

.kibot.yaml

@@ -0,0 +1,71 @@
+# KiPlot config file
+kiplot:
+  version: 1
+
+global:
+  resources_dir: '.resources'
+  units: 'millimeters'
+
+preflight:
+  check_zone_fills: true
+  ignore_unconnected: true
+  run_drc: false
+  update_xml: false
+
+outputs:
+  - name: 'gerbers'
+    comment: "Gerbers for the board house"
+    type: 'gerber'
+    dir: 'gerberdir'
+    options:
+      # generic layer options
+      exclude_edge_layer: false
+      exclude_pads_from_silkscreen: false
+      use_aux_axis_as_origin: false
+      plot_sheet_reference: false
+      plot_footprint_refs: true
+      plot_footprint_values: true
+      force_plot_invisible_refs_vals: false
+      tent_vias: true
+
+      # gerber options
+      line_width: 0.15
+      subtract_mask_from_silk: false
+      use_protel_extensions: false
+      gerber_precision: 4.6
+      create_gerber_job_file: false
+      use_gerber_x2_attributes: false
+      use_gerber_net_attributes: false
+
+    layers:
+      - layer: 'F.Cu'
+        suffix: 'F_Cu'
+      - layer: 'F.Paste'
+        suffix: 'F_Paste'
+      - layer: 'F.SilkS'
+        suffix: 'F_Silks'
+      - layer: 'F.Mask'
+        suffix: 'F_Mask'
+      - layer: 'B.Cu'
+        suffix: 'B_Cu'
+      - layer: 'B.Paste'
+        suffix: 'B_Paste'
+      - layer: 'B.SilkS'
+        suffix: 'B_Silks'
+      - layer: 'B.Mask'
+        suffix: 'B_Mask'
+      - layer: 'B.Mask'
+        suffix: 'B_Mask'
+
+  - name: 'excellon_drill'
+    comment: "Excellon drill files"
+    type: 'excellon'
+    dir: 'gerberdir'
+    options:
+      metric_units: true
+      pth_and_npth_single_file: false
+      use_aux_axis_as_origin: false
+      minimal_header: false
+      mirror_y_axis: false
+      map:
+        type: 'gerber'

uniKeyPCB.kicad_pcb → kicad/uniKeyPCB.kicad_pcb

@@ -44173,6 +44173,18 @@
 			(justify left bottom mirror)
 		)
 	)
+	(gr_text "VCC"
+		(at 100.96 65.48 90)
+		(layer "B.SilkS")
+		(uuid "827b76c9-410c-4b26-9d9e-2d5e9477bf24")
+		(effects
+			(font
+				(size 1 1)
+				(thickness 0.1)
+			)
+			(justify left bottom mirror)
+		)
+	)
 	(gr_text "VCC"
 		(at 143.97 122.03 90)
 		(layer "B.SilkS")
@@ -44857,6 +44869,18 @@
 			(justify left bottom mirror)
 		)
 	)
+	(gr_text "VCC"
+		(at 143.96 65.48 90)
+		(layer "B.SilkS")
+		(uuid "f48b085e-8980-44a0-9790-080256ee0de9")
+		(effects
+			(font
+				(size 1 1)
+				(thickness 0.1)
+			)
+			(justify left bottom mirror)
+		)
+	)
 	(gr_text "VCC"
 		(at 100.97 100.54 90)
 		(layer "B.SilkS")

readme.md

@@ -0,0 +1,15 @@
+# uniKey: A Compact PCB for Single Key Switches
+
+uniKey is a compact printed circuit board (PCB) designed specifically for single key switches. It comes in two variants: one for MX-style switches and another for Chocolate-style switches. Whether you’re a keyboard enthusiast or a DIY enthusiast, uniKey offers a versatile solution for creating custom handwired keyboards.
+
+Features:
+
+* Compact Design: uniKey’s small form factor makes it ideal for handwired keyboard projects.
+* Switch Compatibility: Choose between MX or Chocolate switches based on your preference.
+* LED Support: uniKey includes support for RGB LEDs, allowing you to add customizable lighting effects to your keyboard.
+* Easy Wiring: If you use pin sockets, you can connect each key and LED using jumper wires. Minimal soldering is required—only for the LED, hotswap socket, and pin sockets.
+* Customization: Build your dream keyboard by combining uniKey with your favorite keycaps and switches.
+
+Whether you’re a seasoned keyboard builder or a beginner, uniKey provides a convenient solution for creating unique and personalized keyboards. Happy building! 🚀🔥
+
+![sample pcb](img/pcb.png)