Skip to content

Commit

Permalink
plenking
Browse files Browse the repository at this point in the history
  • Loading branch information
bstiq committed Oct 22, 2023
1 parent 43674e9 commit 9bccb12
Show file tree
Hide file tree
Showing 12 changed files with 21 additions and 21 deletions.
8 changes: 4 additions & 4 deletions _includes/splinky_preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ In your kit, you might get either an Elite-C, or a Splinky/RP2040-compatible boa
- Splinky 

{: .warning }
Make sure to use the "left" shield PCB. Those are not reversible !
Make sure to use the "left" shield PCB. Those are not reversible!

{: .warning }
In the next section, we will install the Splinky onto the shield PCB using the headers. **It is very important to install it on the correct side**, otherwise it will not work. Make sure to look at the pictures carefully
In the next section, we will install the Splinky onto the shield PCB using the headers. **It is very important to install it on the correct side**, otherwise it will not work. Make sure to look at the pictures carefully! 

## Left side - Installing the Splinky

Expand Down Expand Up @@ -121,10 +121,10 @@ In this step, we will solder the audio jack. At this point, we will only solder


{: .warning }
Make sure to use the "right" shield PCB. Those are not reversible !
Make sure to use the "right" shield PCB. Those are not reversible!

{: .warning }
In the next section, we will install the Splinky onto the shield PCB using the headers. It is very important to install it on the correct side, otherwise it will not work. Make sure to look at the pictures carefully !
In the next section, we will install the Splinky onto the shield PCB using the headers. It is very important to install it on the correct side, otherwise it will not work. Make sure to look at the pictures carefully!

## Right side - Installing the components
- Just like previously, install the Splinky, reset button, and audio jack onto the shield
Expand Down
2 changes: 1 addition & 1 deletion bg_charybdis/04screw_inserts.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,6 @@ There is **a third inner hole at the bottom** (in blue). If you are building a *
Follow the same procedure as previously, except:

- with the soldering iron, push the insert all the way in-
- **be careful not to push the insert too far !**- this time, you don't need to flip the case.
- **be careful not to push the insert too far!**- this time, you don't need to flip the case.

![](../assets/pics/guides/charybdis/8.jpg)
2 changes: 1 addition & 1 deletion bg_charybdis/05diodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ If you are preparing a left-handed Charybdis, use the 5-key thumb cluster PCB in
On the thumb cluster PCB, we need to install a total of 3 diodes. They go on the footprints with 2 pads (see pictures below).

{: .warning }
These diodes need to be installed in a specific way, or they will not work ! **Read the following carefully.**
These diodes need to be installed in a specific way, or they will not work! **Read the following carefully.**

- Inspect the 2-legged diodes: there is a horizontal line on them
- This line needs to be aligned with the white markers on the PCBs
Expand Down
2 changes: 1 addition & 1 deletion bg_charybdis/06rgb_components.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Use the below pictures for guidance - note **the resistors and capacitors are in


{: .warning }
The LEDs need to be installed in a very specific way. Read the following instructions carefully **first**, and then install them. **If you don't, they will not work !** 
The LEDs need to be installed in a very specific way. Read the following instructions carefully **first**, and then install them. **If you don't, they will not work!** 

![](../assets/pics/guides/charybdis/27.jpg)

Expand Down
2 changes: 1 addition & 1 deletion bg_charybdis/07ribbon_cables.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In this section, we will connect the PCB plates to the Splinky shields using the



There is the right side and left side, with plate and thumb cluster PCBs. It can get a bit confusing, but not to worry ! We detailed everything, so just read the instructions carefully.
There is the right side and left side, with plate and thumb cluster PCBs. It can get a bit confusing, but not to worry! We detailed everything, so just read the instructions carefully.


{: .tip }
Expand Down
2 changes: 1 addition & 1 deletion bg_charybdis/09cables_to_splinky.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ parent: Build guides - Charybdis

Now that we finished preparing the Splinky and the flexible PCBs, it's time to connect all of them together.

Be careful, because the Splinky shield assemblies are not reversible ! We will start with the left side, and then proceed to the right side.
Be careful, because the Splinky shield assemblies are not reversible! We will start with the left side, and then proceed to the right side.

# Left side

Expand Down
2 changes: 1 addition & 1 deletion bg_charybdis/10install_the_switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ While in theory you can install the switches in any order you like, we outline b


{: .warning }
The case is made of plastic, and will melt if you touch it with your soldering iron. Be careful !
The case is made of plastic, and will melt if you touch it with your soldering iron. Be careful!

# Installing the switches

Expand Down
2 changes: 1 addition & 1 deletion bg_cnano/04screw_inserts.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,6 @@ There is **a third inner hole at the bottom** (in blue). If you are building a *
Follow the same procedure as previously, except:

- with the soldering iron, push the insert all the way in-
- **be careful not to push the insert too far !**- this time, you don't need to flip the case.
- **be careful not to push the insert too far!**- this time, you don't need to flip the case.

![](../assets/pics/guides/charybdis/8.jpg)
6 changes: 3 additions & 3 deletions bg_dilemma/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Install the left 3d print holder. Do not screw it in completely, we will do this

# Connecting the trackpad ribbon cable

Please note: you do not need to desolder any resistors on the trackpad. Just use it as it came in the kit !
Please note: you do not need to desolder any resistors on the trackpad. Just use it as it came in the kit!

Bend the cable like on the picture below :

Expand All @@ -72,7 +72,7 @@ Bend the cable like on the picture below :
![](../assets/pics/guides/dilemmav1/7.jpg)

- Insert the ribbon in the connector
- Make sure you have the same orientation as in the picture below - blue facing up !
- Make sure you have the same orientation as in the picture below - blue facing up!
- Close the ribbon connector


Expand Down Expand Up @@ -106,7 +106,7 @@ Solder in your switches of preference.

# Customize your firmware

You're all done !
You're all done!

Head over to [bstkbd.com/custom](https://bstkbd.com/custom) to customize your keyboard to your needs.

Expand Down
8 changes: 4 additions & 4 deletions bg_dilemma/v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ parent: Build guides - Dilemma
If you ordered a kit with per-key RGB, we will start by installing those. If you don't have LEDs, you can skip to the next section.

{: .warning }
The LEDs need to be installed in a very specific way. Read the following instructions carefully first, and then install them. If you don't, they will not work !
The LEDs need to be installed in a very specific way. Read the following instructions carefully first, and then install them. If you don't, they will not work!


![](../assets/pics/guides/dilemmav2/12.jpg)
Expand All @@ -40,7 +40,7 @@ The LEDs are sensitive to heat. Stay at most 2 seconds on each pad. If that does

# Soldering the audio jacks and reset buttons

- There is only one way the components can be installed, so there's no risk of messing up !
- There is only one way the components can be installed, so there's no risk of messing up!
- Solder in the audio jacks
- Solder in the reset buttons- **When installing the reset button, take care not to short the pads to the vias nearby.**
- The vias are the round metal holes.
Expand Down Expand Up @@ -79,7 +79,7 @@ The kit comes with grey screws. If you ordered a case, you will also get black s

# Connecting the trackpad ribbon cable

**Please note**: you **do not need** to desolder any resistors on the trackpad. Just **use it as it came in the kit !**
**Please note**: you **do not need** to desolder any resistors on the trackpad. Just **use it as it came in the kit!**

- On the **Right side of the keyboard**,
- Open the FPC connector
Expand Down Expand Up @@ -118,7 +118,7 @@ Solder in your switches of preference.

# Customize your firmware

You're all done !
You're all done!

Head over to [bstkbd.com/custom](https://bstkbd.com/custom) to customize your keyboard to your needs.

Expand Down
4 changes: 2 additions & 2 deletions help/diagnose_broken_trace.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To diagnose a broken connection, you will need the following tools:
We will use the multimeter to diagnose if / where a broken trace could be, and git / kicad to figure out how to fix it.

{: .warning }
When doing any kind of measuring or soldering on the keyboard, it is **extremely important** that you unplug it first !
When doing any kind of measuring or soldering on the keyboard, it is **extremely important** that you unplug it first!

# I, O, P switches not working on 4x6 keyboard

Expand Down Expand Up @@ -62,7 +62,7 @@ When looking at this, it seems that there might be a broken connection between `
Now that we have an idea of what could be broken, let's confirm that on the keyboard.

{: .warning }
Once again - before you do any kind of measuring, it is **extremely important** that you unplug your keyboard first !
Once again - before you do any kind of measuring, it is **extremely important** that you unplug your keyboard first!

Set your multimeter to continuity mode. Most often a "sound" pictogram represents this mode, and often a diode symbol is placed next to it, because continuity mode often doubles as diode testing mode. Touch the probe tips together to verify you can hear a beep, or observe a change in the multimeter's display, depending on your model.

Expand Down
2 changes: 1 addition & 1 deletion help/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ parent: Help
# Hotswap

Check warning on line 11 in help/faq.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (Hotswap)

{: .question }
Is it possible to build a hotswap Bastard Keyboard ?
Is it possible to build a hotswap Bastard Keyboard?

Check warning on line 14 in help/faq.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (hotswap)

**On the 3d keyboards (Scylla, Charybdis...):**
It's not possible to use MX sockets, because they need a specific footprint on the PCB which is not present. It is in theory possible to use Millmax sockets, though not recommended.

Check warning on line 17 in help/faq.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (Millmax)
Expand Down

0 comments on commit 9bccb12

Please sign in to comment.