Skip to content

Commit 096b032

Browse files
authored
Merge pull request #4 from VideoGameInformation/parkers-doc-catchup
build guide shit
2 parents 5ba2da0 + 437d194 commit 096b032

File tree

10 files changed

+135
-27
lines changed

10 files changed

+135
-27
lines changed

.DS_Store

0 Bytes
Binary file not shown.

build_guides/.DS_Store

0 Bytes
Binary file not shown.

build_guides/LULU_kit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ https://i.imgur.com/k9hUQhm_d.jpg?maxwidth=520&shape=thumb&fidelity=high
1919
### Required
2020
| Item | Count |
2121
|------|-------|
22-
| DIODESTYLE Diodes | 58 |
23-
| PCB | PCBCOUNT |
22+
| SMD Diodes | 58 |
23+
| PCB | 2 |
2424
| Promicro style or similar microcontroller | 1 |
2525
| TRRS Jack | 2 |
2626
| TRRS Cable | 1 |

build_guides/Rev34build_guide_.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
title: Reviung34 Build Guide
3+
description: How to put together your new Reviung34 solderable kit.
4+
author: Boardsource
5+
product_link: https://boardsource.xyz/store/5f2ef1b52bf5e8714a60f613
6+
subcategory: medium
7+
draft: false
8+
tags:
9+
- 30%
10+
- ergo
11+
- kit
12+
banner: https://i.imgur.com/cXcIuV6.jpg
13+
thumbnail: https://i.imgur.com/cXcIuV6.jpg
14+
---
15+
### This guide is for *KEYBOARDNAME* PCBs.
16+
https://i.imgur.com/GFpmPNH.jpg
17+
# Parts
18+
### Required
19+
| Item | Count |
20+
|------|-------|
21+
| SMT Diodes | 33-34 |
22+
| PCB | PCBCOUNT |
23+
| Pro micro stlye or similar microcontroller | Blok |
24+
| Reset Switch | 1 |
25+
| SOCKETSTYLE Hotswap Sockets | 33-34 |
26+
| SWITCHSTYLE Switches | 33-34 |
27+
| *KEYCAPSTYLE* Keycaps | 33-34 |
28+
29+
### Optional
30+
| Item | Count |
31+
|------|-------|
32+
| WS2812B LED | 8 |
33+
34+
![components](https://i.imgur.com/CGflXKX.jpg)
35+
36+
# Soldering
37+
## Diodes
38+
**Orientation**: Black bar facing downwards or towards the footprint indicator.
39+
1. Solder one pad.
40+
![one pad - diode](https://i.imgur.com/l75iEcb.jpg)
41+
2. While holding diode with tweezers, reflow solder and place diode down on pad.
42+
![diode placed](https://i.imgur.com/qWvV8EY.jpg)
43+
3. Solder other pad.
44+
![diode complete](https://i.imgur.com/kE9cqeO.jpg)
45+
- Note, when working with [MELF](https://en.wikipedia.org/wiki/Metal_electrode_leadless_face) package diodes,
46+
you may need to reflow and add more solder a couple times before an adequate connection is made.
47+
48+
## LEDs
49+
**Orientation**: Notched corner/pin facing the pad marked with rectangle. This applies for both SK6812 Mini-E & WS2812B LEDs.
50+
![sk6812 mini e orientation](LEDORIENTATIONIMG1)
51+
![ws2812b orientation](LEDORIENTATIONIMG2)
52+
- Notes: \
53+
\- This component is heat sensitive. Be cautious and work at a safe temp (~300c). \
54+
\- It is wise to test the LEDs as you solder then. Consider [soldering your controllers beforehand](#microcontrollers). \
55+
\- The LED order is somewhat outlined ![LED order](LEDORDERIMG) and should be followed in order when building.
56+
1. Solder one pad. (it may be easier to solder all 4 pads before placing LED down when installing WS2812B LEDs)
57+
![sk6812 mini e one pad](LEDCLOSEUPIMG1)
58+
![ws2812b 4 pads](https://i.imgur.com/VdBHZeh.jpg)
59+
2. While holding LED with tweezers, reflow solder and place LED down on pad.
60+
![sk6812 mini e placed](LEDCLOSEUPIMG3)
61+
![ws2812b placed](https://i.imgur.com/7nsE6Ud.jpg)
62+
3. Solder remaining pads.
63+
![sk6812 mini e complete](LEDCLOSEUPIMG5)
64+
65+
## Hotswap sockets
66+
1. Solder one pad.
67+
![Hot swap socket foot print soldered](https://i.imgur.com/Q4Jvemy.jpg)
68+
2. While holding hotswap socket (fingers are fine), reflow solder and place socket down on pad.
69+
![Hot swap socket one pin soldered](https://i.imgur.com/p6SgExz.jpg)
70+
3. Solder other pad.
71+
![Hot swap socket finished](https://i.imgur.com/bFMwdHh.jpg)
72+
- Note, don't hesitate to use a little extra solder, as that will help secure the socket and prevent it from being ripped off.
73+
74+
## Microcontrollers
75+
**Orientation**: Both microcontrollers CONTROLLERPLACEMENT.
76+
- Note, it is recommended to flash each microcontroller prior to soldering. See [firmware](#firmware) section for more.
77+
1. Insert headers from front, solder in from the back.
78+
![headers inserted](https://i.imgur.com/LQE4ido.jpg)
79+
2. Place microcontroller CONTROLLERPLACEMENT.
80+
![microcontroller placed](https://i.imgur.com/7jRClJk.jpg)
81+
3. Apply solder to all pins.
82+
4. Use flush cutters or similar to trim excess from pins on each side.
83+
![microcontroller finished](https://i.imgur.com/k9s3qkn.jpg)
84+
85+
### Reset switches
86+
1. Solder one pad.
87+
![reset switch placed](https://i.imgur.com/Qm0ER53.jpg)
88+
2. While holding switch with tweezers, reflow solder and place switch down on pad.
89+
3. Solder remaining pads.
90+
![reset switch placed](https://i.imgur.com/fWRp5LL.jpg)
91+
92+
93+
94+
## Firmware
95+
96+
### QMK
97+
In qmk this keyboard can be found under QMKKEYBOARDNAME.
98+
To begin, follow the [QMK setup guide](https://docs.qmk.fm/#/newbs_getting_started). (if working from an existing installation, an [update](https://docs.qmk.fm/#/newbs_git_using_your_master_branch?id=updating-your-master-branch) may be needed.) \
99+
For flashing instructions, see [doc](https://docs.qmk.fm/#/newbs_flashing) or [video](https://www.youtube.com/watch?v=fuBJbdCFF0Q)
100+
101+
### KMK / PEG
102+
In Peg or KMK this keyboard can be found under KMKKEYBOARDNAME
103+
104+
Peg can be downloaded [here](https://peg.software/), and the quick start can be seen [here](https://peg.software/docs/Peg_Client/#quick-start-and-testing).
105+
106+
For Kmk can be downloaded [here](https://github.com/KMKfw/kmk_firmware) and the quick start can be seen [here](http://kmkfw.io/docs/Getting_Started#tldr-quick-start-guide)
107+
108+
109+
110+
## Extra
111+
For questions, ask in [Boardsource Discord server](https://discord.gg/5qpqbgaTYz)

build_guides/arachno.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ https://i.imgur.com/8zi3Gt9.jpg
1818
### Required
1919
| Item | Count |
2020
|------|-------|
21-
| DIODESTYLE Diodes | 30 |
21+
| SMD Diodes | 30 |
2222
| PCB | 1 |
2323
| Seeed Style or similar microcontroller | 1 |
2424
| Reset Switch | 0 |

build_guides/architeuthis_dux.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ thumbnail: https://i.imgur.com/VhvY3Do.png
1717
### Required
1818
| Item | Count |
1919
|------|-------|
20-
| DIODESTYLE Diodes | 30 |
21-
| PCB | PCBCOU2NT |
20+
| SMD Diodes | 30 |
21+
| PCB | 2 |
2222
| Promicro-style or similar microcontroller | 2 |
2323
| TRRS Jack | 2 |
2424
| TRRS Cable | 1 |
@@ -46,7 +46,7 @@ thumbnail: https://i.imgur.com/VhvY3Do.png
4646
- Note, it is recommended to flash each microcontroller prior to soldering. See [firmware](#firmware) section for more.
4747
1. Insert headers from front, solder in from the back.
4848
![headers inserted](https://i.imgur.com/qiEeM6d.jpg)
49-
2. Place microcontroller CONTROLLERPLACEMENT.
49+
2. Place microcontroller one component face down and one componant face up.
5050
![microcontroller placed](https://i.imgur.com/5ApcPZW.jpg)
5151
3. Apply solder to all pins.
5252
4. Use flush cutters or similar to trim excess from pins on each side.

build_guides/equals_kit-!!needs-finished-controller-pic!!.md renamed to build_guides/equals_kit.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ tags:
1010
- ergo
1111
- kit
1212
banner: https://i.imgur.com/OOQouF0.jpg
13-
thumbnail: https://i.imgur.com/NjN2XvX.png
13+
thumbnail: https://i.imgur.com/uPUZxvA.png
1414
---
1515
### This guide is for *EQUALS* PCBs
1616
# Parts
1717
### Required
1818
| Item | Count |
1919
|------|-------|
20-
| DIODESTYLE Diodes | 60 |
20+
| SMD Diodes | 60 |
2121
| PCB | 1 |
2222
| Promicro style or similar microcontroller | 1 |
2323
| Reset Switch | 1 |
@@ -47,7 +47,7 @@ you may need to reflow and add more solder a couple times before an adequate con
4747
## LEDs
4848
**Orientation**: Notched corner/pin facing the pad marked with rectangle. This applies for both SK6812 Mini-E & WS2812B LEDs.
4949
![sk6812 mini e orientation](https://i.imgur.com/hcw94Po_d.jpg?maxwidth=520&shape=thumb&fidelity=high)
50-
![ws2812b orientation](LEDORIENTATIONIMG2)
50+
![ws2812b orientation](https://i.imgur.com/guu0UiP.jpgx)
5151
- Notes: \
5252
\- This component is heat sensitive. Be cautious and work at a safe temp (~300c). \
5353
\- It is wise to test the LEDs as you solder then. Consider [soldering your controllers beforehand](#microcontrollers). \
@@ -81,7 +81,7 @@ you may need to reflow and add more solder a couple times before an adequate con
8181
![microcontroller placed](https://i.imgur.com/Z80g7oY.jpg)
8282
3. Apply solder to all pins.
8383
4. Use flush cutters or similar to trim excess from pins on each side.
84-
![microcontroller finished](CONTROLLERCLOSEUPIMG3)
84+
![microcontroller finished](https://i.imgur.com/BZrXPIU.jpg)
8585

8686

8787
## Misc

build_guides/osprette.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ tags:
1010
- ergo
1111
- kit
1212
- mono block
13-
banner: https://i.imgur.com/KANSwLX.jpg
14-
thumbnail: https://i.imgur.com/KANSwLX.jpg
13+
banner: https://i.imgur.com/ZZ4tMHq.jpg
14+
thumbnail: https://i.imgur.com/1AlKBKg.png
1515
---
1616
# This guide is for *Osprette* PCBs.
1717
https://i.imgur.com/Ba753EB.jpg
1818
# Parts
1919
### Required
2020
| Item | Count |
2121
|------|-------|
22-
| DIODESTYLE Diodes | 34 |
22+
| SMD Diodes | 34 |
2323
| PCB | 1 |
24-
| CONTROLLERSTYLE or similar microcontroller | 1 |
24+
| Primicro style controller or similar microcontroller | 1 |
2525
| Reset Switch | 1 |
2626
| MX Hotswap Sockets | 34 |
2727
| MX Switches | 34 |

build_guides/slab_V.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ tags:
99
- 30%
1010
- ergo
1111
- kit
12-
banner: https://boardsource.imgix.net/Missing
13-
thumbnail: https://boardsource.imgix.net/Misssing
12+
banner: https://i.imgur.com/QQrKQVa.jpg
13+
thumbnail: https://i.imgur.com/05bTLDm.png
1414
---
1515

1616
### This guide is for *Slab-V* PCBs.
@@ -21,10 +21,8 @@ https://imgur.com/a/Crzchlb
2121
|------|-------|
2222
| SMD Diodes | 36 |
2323
| PCB | 1 |
24-
| Pro-Micro or similar microcontroller | 2 |
25-
| TRRS Jack | 2 |
26-
| TRRS Cable | 1 |
27-
| Reset Switch | 2 |
24+
| Pro-Micro or similar microcontroller | 1 |
25+
| Reset Switch | 1 |
2826
| MX Hotswap Sockets | 36 |
2927
| MX Switches | 36 |
3028
| MX Keycaps | 36 |
@@ -60,20 +58,20 @@ you may need to reflow and add more solder a couple times before an adequate con
6058
**Orientation**: microcontroller face down.
6159
- Note, it is recommended to flash each microcontroller prior to soldering. See [firmware](#firmware) section for more.
6260
1. Insert headers from front, solder in from the back.
63-
![headers inserted](https://imgur.com/HbvlkJG.jpg)
61+
![headers inserted](https://i.imgur.com/WnskwTu.jpg)
6462
2. Place microcontroller face down.
65-
![microcontroller placed](https://imgur.com/jrOQnpv.jpg)
63+
![microcontroller placed](https://i.imgur.com/XmPy5PG.jpg)
6664
3. Apply solder to all pins.
6765
4. Use flush cutters or similar to trim excess from pins on each side.
68-
![microcontroller finished](https://imgur.com/Qlphzkj.jpg)
66+
![microcontroller finished](https://i.imgur.com/dSudrie.jpg)
6967

7068
## Misc.
7169
### Reset switches
7270
1. Solder one pad.
73-
![reset switch placed](https://imgur.com/wjKfxHU.jpg)
71+
![reset switch placed](https://i.imgur.com/ASdlNhU.jpg)
7472
2. While holding switch with tweezers, reflow solder and place switch down on pad.
7573
3. Solder remaining pads.
76-
![reset switch placed](https://imgur.com/PXBCfUV.jpg)
74+
![reset switch placed](https://i.imgur.com/VFgfU0N.jpg)
7775

7876

7977

build_guides/sweep.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ thumbnail: https://i.imgur.com/Bgjz9pO.png
1818
### Required
1919
| Item | Count |
2020
|------|-------|
21-
| DIODESTYLE Diodes | 34 |
2221
| PCB | 2 |
2322
| Promicro style or similar microcontroller | 2 |
2423
| TRRS Jack | 2 |
@@ -36,7 +35,7 @@ thumbnail: https://i.imgur.com/Bgjz9pO.png
3635
1. Solder one pad.
3736
![Hot swap socket foot print soldered](https://i.imgur.com/0NiHxI1.jpg)
3837
2. While holding hotswap socket (fingers are fine), reflow solder and place socket down on pad.
39-
![Hot swap socket one pin soldered](SOCKETCLhttps://i.imgur.com/eueMfUN.jpgOSEUPIMG2)
38+
![Hot swap socket one pin soldered](https://i.imgur.com/aJU0Wbm.jpg)
4039
3. Solder other pad.
4140
![Hot swap socket finished](https://i.imgur.com/3T4OOt8.jpg)
4241
- Note, don't hesitate to use a little extra solder, as that will help secure the socket and prevent it from being ripped off.

0 commit comments

Comments
 (0)