~shiny/ergosnap

e990b8742e90db4d7bf398585a425e10d6734be1 — Thomas Spurden 5 years ago da7dad6
Add basic BOM & SW sections to readme
1 files changed, 25 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +25 -0
@@ 29,10 29,35 @@ I got my PCBS made at [JLCPCB][5]. No issues.

[5]: https://jlcpcb.com/

## BOM

 - 4 x PCBs
 - 68 x Keyswitches (with diode holes - wider than LED holes! I used Zealios)
 - 68 x Diodes (1N4148)
 - 2 x ProMicro + header pins 
 - 2 x TRRS jacks (PJ-320A [aliexpress](https://www.aliexpress.com/item/32825553898.html))
 - 1 x TRRS cable
 - 2 x 4k7 Ohm resistors (I2C pullups)
 - 2 x 5pin headers
 - 4 x M6 nylon screw thread + nuts (for tenting, optional)
 - Some sticky-backed neoprene tape (optional, for padding/non-slip on the bottom
  of the board

## Build

See [build guide](build_guide/).

## Software

[QMK](https://qmk.fm/). ErgoSnap uses exactly the same matrix as the ErgoDash,
so just build an ErgoDash layout (using the `LAYOUT_3key_1us` layout type).

For an example see my [`ergodash-isolike` layout](https://github.com/tcrs/qmk_firmware/tree/ergosnap-isolike).

Example make command:

	make ergodash/rev1:isolike:avrdude

## License

ErgoDash & Ergo42 are MIT, Mitosis is GPLv3. So this work as a whole is GPLv3.