Skip to content

Commit

Permalink
flesh out README, including more images
Browse files Browse the repository at this point in the history
  • Loading branch information
brow committed Jan 1, 2022
1 parent 69a1025 commit 50adb80
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 10 deletions.
49 changes: 39 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,45 @@
# Balbuzard

![photo of assembled keyboard](images/assembled.jpg)
Balbuzard is a compact, ergonomic keyboard with 34–38 keys.

Balbuzard is a 36-key keyboard with a PCB. This repository contains the [Ergogen](https://github.com/mrzealot/ergogen) configuration that generates the KiCad PCB file.
<img src="images/0.2_smores.jpg" height="225" alt="assembled Balbuzard 0.2" />

## Usage
## How do you type on that?
I've used Balbuzard as my main keyboard since 2019. My keymap looks like this:

<img src="images/layout.png" width="450"/>

_Mod 1_ and _Mod 2_ activate alternate layers of the keymap, which contain symbols, arrows, backspace, etc.

## Versions

### [0.2: Low-profile](https://github.com/brow/balbuzard/releases/tag/v0.2)

<img src="images/0.2_brow.jpg" height="225"/>
<img src="images/0.2_bottom.jpg" height="225"/>

- 34–38 keys
- Compatible with Choc (low-profile) switches
- SMD diodes hidden beneath switches
- Silkscreen on bottom
- Tighter key spacing
- Viewing window under microcontroller
- Adjustments to positions of columns and thumb keys

### [0.1: Classic](https://github.com/brow/balbuzard/releases/tag/v0.1)

<img src="images/0.1_assembled.jpg" height="250"/>
<img src="images/0.1_diodes.jpg" height="250"/>

- 36 keys
- Compatible with MX, Alps, and Choc (low-profile) switches
- Through-hole diodes tucked between switches
- Silkscreen on top


## Using this repository

This repo contains the [Ergogen](https://github.com/mrzealot/ergogen) configuration that generates the KiCad PCB file.

Assuming you have [npm installed](https://www.npmjs.com/get-npm):

Expand All @@ -16,10 +51,4 @@ make

Find the generated PCB at `output/pcbs/main.kicad_pcb`.

![pcb thumbnail image](images/pcb.png)

## How do you type on that?

My keymap looks like this. The colors indicate which finger I use to hit each key.

![example keymap](images/layout.png)
![pcb thumbnail image](images/pcb.png)
File renamed without changes
Binary file added images/0.1_diodes.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/0.2_bottom.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/0.2_brow.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/0.2_smores.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 50adb80

Please sign in to comment.