Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add keymaps page with pretty graphics of all stock keymaps #4

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,7 @@ overtighten
Kapton
Din
Dout
Keycaps
Pseudoku
Asymplex
daughterboard
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ gem "just-the-docs", "0.7.0" # pinned to the current release
gem "jekyll-remote-theme"

gem "jekyll-default-layout"

gem "json" # work around upstream bug (?)
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ exclude:
- Gemfile.lock
- _site/
- building-locally.md
- cspell.config.yaml

plugins:
- jekyll-default-layout
Expand Down
6 changes: 3 additions & 3 deletions _includes/splinktegrated_preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ In this section, we will solder headers to the PCB. **They will be close to some
![](../assets/pics/guides/splinktegrated/7.jpg)

- Inspect the front of the assembly: 
- Make sure that the headers are flush with the motherboard and daugtherboard
- Make sure that the headers are flush with the motherboard and daughterboard
- Solder the top headers, then the bottom headers
- Finally, cut the headers to make them flush using pliers

Expand Down Expand Up @@ -151,7 +151,7 @@ In the next section, we will prepare the first Splinktegrated by installing the
![](../assets/pics/guides/splinktegrated/8.jpg)

- Inspect the front of the assembly: 
- Make sure that the headers are flush with the motherboard and daugtherboard
- Make sure that the headers are flush with the motherboard and daughterboard
- Solder the top headers, then the bottom headers
- Finally, cut the headers to make them flush using pliers

Expand Down Expand Up @@ -213,4 +213,4 @@ You now have 2 Splinktegrated assemblies. Make sure they match with the pictures

![](../assets/pics/guides/splinktegrated/23.jpg)

![](../assets/pics/guides/splinktegrated/24.jpg)
![](../assets/pics/guides/splinktegrated/24.jpg)
14 changes: 14 additions & 0 deletions _includes/testing_pcb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Testing before case installation

Now is a great time to function test the assembled PCBs, as any troubleshooting steps you might need to complete will be much easier to do while the plates are still outside of the case.

{: .info }
The TRRS connection will not work yet, as only ony one leg of the jack is connected. You can test this part later.

To begin, connect one half to your PC via USB. If you have RGB, observe the LEDs. Do they all light up? Are the colors correct, and can you see a rainbow animation play?

To test the switches, open [VIA](https://usevia.app/). After connecting to your device, switch to the key tester page using the stethoscope pictogram, then activate the "Test Matrix" option. Now, you can connect each pair of switch pads in turn, using your tweezers, a wire, or a short length of solder.

![]({{site.baseurl}}/assets/pics/guides/generic/via-test-matrix.png)

Did they all light up? Great, proceed to case installation! Not quite perfect yet? Don't worry, proceed to the [Troubleshooting]({{site.baseurl}}/help/troubleshooting.html) section!
Binary file added assets/pics/guides/generic/via-test-matrix.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions bg_charybdis/10install_the_switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ parent: Build guide - Charybdis
1. TOC
{:toc}

{% include testing_pcb.md %}

# Introduction

Now that everything is connected together, the next step is to install the switches and the PCBs into the case. The process is exactly the same for both sides, so we will detail only the Scylla side (without trackball).
Expand Down
1 change: 1 addition & 0 deletions bg_cnano/10install_the_switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ parent: Build guide - Charybdis Nano
1. TOC
{:toc}

{% include testing_pcb.md %}

# Introduction

Expand Down
4 changes: 3 additions & 1 deletion bg_scylla/10install_the_switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ parent: Build guide - Scylla
1. TOC
{:toc}

{% include testing_pcb.md %}

# Introduction

Now that everything is connected together, the next step is to install the switches and the PCBs into the case. The process is exactly the same for both sides, so we will detail only the Scylla side (without trackball).
Expand Down Expand Up @@ -38,4 +40,4 @@ When installing the switches, use the following technique:
- start with the top two switches (labeled 1, in red on the picture)
- continue with the outer four switches (labeled 2, in blue on the picture)
- continue with the bottom six switches (labeled 3, in green on the picture)
- finally, install the rest of the switches
- finally, install the rest of the switches
1 change: 1 addition & 0 deletions bg_skeletyl/10install_the_switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ parent: Build guide - Skeletyl
1. TOC
{:toc}

{% include testing_pcb.md %}

# Introduction

Expand Down