Merge pull request #9 from thrly/v2

V2

Author: thrly

README.md

@@ -1,34 +1,31 @@
 # TEMPEST
 
-_a 36-key split ergonomic keyboard_
+a 36/38-key split ergonomic keyboard
 
 ![Maintenance](https://img.shields.io/maintenance/yes/2025) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/thrly/tempest)
-
-![TEMPEST keyboard](images/tempest-white.jpg)
+![Tempest](images/tempest.jpg)
 
 ## Design
 
 - Five columns, three rows, three thumb keys
+  - Optional extra key for 36 or 38-key configuration (snap-off pcb)
 - Column stagger and splay on the pinky and ring columns
 - Powered by nice!nano / pro micro microcontroller
+- Optional nice!view display
 - Designed for wireless use + battery
 - Low profile v1 Choc switches + hotswap sockets
 - Reversible PCB
 - Uses some components (JST plug, power switch, reset) from the Typeractive Corne design
 - Layout designed with [Ergogen](https://ergogen.ceoloide.com/) (see [config.yaml](./ergogen/config.yaml))
 - PCB designed with [KiCad](https://www.kicad.org/) (v 9)
-- Simple 3D-printable case
-
-> [!NOTE]
-> Despite the footprint for it, there is **no working display** on the current version (1.1). The display header pins are not connected correctly. See issue [#7](https://github.com/thrly/tempest/issues/7). You could probably hand-wire the holes to the microcontroller pins to fix though...
+- Simple 3D-printable case for both 36 and 38-key layouts
 
-![TEMPEST keyboard](images/tempest.jpg)
+![TEMPEST pcb](images/tempest-pcb.png)
 
 ## Firmware
 
 TEMPEST was designed to be used with ZMK. [You can find the ZMK-config repository and a keymap here.](https://github.com/thrly/tempest-zmk)
 
-
 ## Build Guide
 
 [Details on the build and case can be found here.](/build-guide.md)

build-guide.md

@@ -4,6 +4,8 @@ The build for the TEMPEST is simple and broadly follows the same steps outlined
 
 Some important notes, however:
 
+Before starting your build, decide if you want the 'extra' outer keys or want the simple 5-column 36-key configuration. If removing the extra keys, simply snap them off the pcb. You may find the break-off points are sharp, so file/sand them down. **WARNING**: the dust from this is toxic, wear a mask and do it outside.
+
 > [!IMPORTANT]
 > Microcontroller should be placed **facing DOWN** (i.e. facing the board).
 
@@ -13,7 +15,7 @@ Some important notes, however:
 > [!IMPORTANT]
 > Ensure that you solder the jumper pads for microcontroller, display, and battery plug closed **on the BACK side of the board** (i.e. the same side you're soldering your hotswap switch plugs and diodes).
 
-![TEMPEST keyboard](images/tempest-2.jpg)
+![TEMPEST keyboard](images/tempest.jpg)
 
 ## Case
 
@@ -33,15 +35,15 @@ Ergogen was used mainly as a layout tool for the keys and wiring nets. Some of t
 
 ## Ordering the PCB
 
-Use [tempest_gerbers_v1.zip](/tempest_gerbers_v1.zip) for PCB fabrication (i.e. JLPCB, PCBWay).
+Use [tempest_v2_gerbers.zip](./tempest-v2-gerbers.zip) for PCB fabrication (i.e. JLPCB, PCBWay).
 
 ### Suggested fabrication options
 
 - FR-4 PCB, 1.6 mm
 - LeadFree HASL
 
-Latest [KiCad_PCB file](/tempest_pcb_v1.1.kicad_pcb) is included, or files can be generated using Ergogen.
+Latest [KiCad_PCB file](./tempest-pcb-v-2.kicad_pcb) is included, or files can be generated using Ergogen.
 
-![TEMPEST PCB Image](images/tempest-pcb-v1-1.png)
+![TEMPEST PCB Image](images/tempest-pcb.png)
 
-> Tempest PCB v1.1
+> Tempest PCB v2