Merge branch 'master' of https://github.com/Bastardkb/bastardkb.githu…

…b.io

.wordlist.txt

@@ -60,7 +60,7 @@ TODO
 multimeter
 keypress
 MCU
-!dilemma
+Dilemma
 TRRS
 KiCad
 Millmax
@@ -94,3 +94,44 @@ udev
 
 Singel
 LEBASTARD
+
+Alli # keeps getting detected as a word in youtube video id in embed
+upstreaming
+userspace
+realpath
+usevia # keeps being detected in the url
+
+erenatas
+JLCPCB
+DDCR
+ROHS
+olidacombe's
+erenatas
+Perixx
+Aliexpress
+Flexstrip
+Microcontrollers
+keebs
+Hakko
+GALLUNOPTIMAL
+Pinecil
+scotto
+colemak
+inorichi
+petejohanson
+erenata's
+grassfedreeve
+nicenano
+SPDT
+Erenata
+
+RMOD
+noeeprom
+eeprom
+drgscrl
+dragscroll
+reflash
+
+hidraw
+uaccess
+udevadm

_includes/use_keyboard.md

@@ -0,0 +1,51 @@
+# Table of contents
+
+1. TOC
+{:toc}
+
+# Introduction
+
+Congratulations on successfully building your keyboard!
+
+The Bastard Keyboards come with a range of features, and it's also easy to customize them. On this page you will find additional information on how to use them and make them your own.
+
+# Daily use
+
+## Default keymap
+
+You can find pictures of the default keymaps on the [default keymaps page][keymaps].
+
+Alternatively, you can also plug in your keyboard and visualize the keymap using VIA (see VIA section).
+
+# Customization
+
+For customizing your keyboard, you can:
+
+- use VIA
+- use QMK
+
+## Using VIA
+
+All Bastard Keyboards come flashed with a VIA-enabled firmware. VIA is an additional layer that comes on top of QMK, and comes with a handy graphical interface. While it's limited in features, it removes the need to manage a git repository, the console and a QMK installation.
+
+You can open the [VIA Web Interface through usevia.app](https://usevia.app/). At the moment, only WebHID-enabled browsers work (eg. Chrome and Chromium-based).
+
+You can check the following tutorial on how to use it:
+{% include youtube.html id="cYICAlliJfU" %}
+
+Through VIA, you can customize:
+- the keymap
+- macros, layers
+- RGB
+
+## Using QMK
+
+This is for advanced users. 
+
+For how to compile a custom hardware for your keyboard, take a look at the [how to compile your own firmware page][compile-firmware].
+
+---
+
+[compile-firmware]: {{site.baseurl}}/fw/compile-firmware.html
+[keymaps]: {{site.baseurl}}/fw/default-keymaps.html
+[flashing]: {{site.baseurl}}/fw/flashing.html

_includes/customize_keyboard.md → _includes/use_keyboard_chary.md

@@ -34,20 +34,23 @@ The most important ones are on the thumb cluster - it transforms into mouse butt
 
 ### Sniping 
 
-Sniping **slows down the trackball**. This way, you can move the cursor more precisely.
+Sniping **slows down the trackball/trackpad**. This way, you can move the cursor more precisely.
 
 By default, Sniping mode is activated when you hold the `MOUSE + SNIP` keys at the same time.
 You can also configure qmk to have it activated automatically.
 
-## Miryoku
+# Customization
 
-The 3x5 keyboards (Skeletyl, Charybdis Nano) come flashed with [Miryoku](https://github.com/manna-harbour/miryoku). On its github repository you will find useful information on the different layers available.
+For customizing your keyboard, you can:
 
-# Customization
+- use VIA
+- use QMK
 
 ## Using VIA
 
-All Bastard Keyboards come flashed with VIA. You can open the [VIA Web Interface through use.via.app](https://usevia.app/). At the moment, only WebHID-enabled browsers work (eg. Chrome and Chromium-based).
+All Bastard Keyboards come flashed with VIA. VIA is an additional layer that comes on top of QMK, and comes with a handy graphical interface. While it's limited in features, it removes the need to manage a git repository, the console and a QMK installation.
+
+You can open the [VIA Web Interface through usevia.app](https://usevia.app/). At the moment, only WebHID-enabled browsers work (eg. Chrome and Chromium-based).
 
 You can check the following tutorial on how to use it:
 {% include youtube.html id="cYICAlliJfU" %}
@@ -59,14 +62,16 @@ Through VIA, you can customize:
 
 ## Using QMK
 
-You can find the latest **default images** for all Bastard Keyboards in the release section of the [BastardKB QMK fork](https://github.com/Bastardkb/bastardkb-qmk/releases).
-
-For how to flash your keyboard, take a look at the [how to flash your keyboard page][flashing].
+This is for advanced users. 
 
-For **advanced customization of the Charybdis and Charybdis Nano**, take a look at the [customize page][customize].
+- how to compile a custom hardware for your keyboard: [how to compile your own firmware][compile-firmware].
+- advanced customization of the Charybdis (and smaller variants): [customize your Charybdis][customize-chary].
+- advanced customization of the Dilemma (and smaller variants): [customize your Dilemma][customize-dilemma].
 
 ---
 
-[customize]: {{site.baseurl}}/fw/charybdis-features.html
+[customize-chary]: {{site.baseurl}}/fw/charybdis-features.html
+[customize-dilemma]: {{site.baseurl}}/fw/dilemma-features.html
 [keymaps]: {{site.baseurl}}/fw/default-keymaps.html
-[flashing]: {{site.baseurl}}/fw/flashing.html
+[flashing]: {{site.baseurl}}/fw/flashing.html
+[compile-firmware]: {{site.baseurl}}/fw/compile-firmware.html

bg_charybdis/13customize.md

@@ -1,9 +1,9 @@
 ---
 layout: default
-title: Customizing your keyboard
+title: Using your keyboard
 nav_order: 13
 parent: Build guide - Charybdis
 ---
 
 
-{% include customize_keyboard.md %}
+{% include use_keyboard_chary.md %}

bg_cnano/13customize.md

@@ -1,9 +1,9 @@
 ---
 layout: default
-title: Customizing your keyboard
+title: Using your keyboard
 nav_order: 13
 parent: Build guide - Charybdis Nano
 ---
 
 
-{% include customize_keyboard.md %}
+{% include use_keyboard_chary.md %}

bg_dilemma/customize.md

@@ -0,0 +1,9 @@
+---
+layout: default
+title: Using your Dilemma
+nav_order: 99
+parent: Build guide - Dilemma
+---
+
+
+{% include use_keyboard_chary.md %}

bg_dilemma/intro.md

@@ -11,5 +11,7 @@ We recommend you start by reading the *required tools* section.
 
 There are written guides, and there are also video guides in the *video guides* section.
 
+For building the Dilemma MAX, just follow the Dilemma instructions - it's the same keyboard, just bigger.
+
 1. TOC
 {:toc}

bg_dilemma/v1.md

@@ -108,6 +108,5 @@ Solder in your switches of preference.
 
 You're all done!
 
-Head over to [bstkbd.com/custom](https://bstkbd.com/custom) to customize your keyboard to your needs.
+Head over to [Customize your Dilemma firmware][use-dilemma] to customize your keyboard to your needs.
 
-If you need any help with it, make sure to hop on the discord : [bstkbd.com/discord](https://www.bstkbd.com/discord)

bg_dilemma/v2.md

@@ -120,6 +120,8 @@ Solder in your switches of preference.
 
 You're all done!
 
-Head over to [bstkbd.com/custom](https://bstkbd.com/custom) to customize your keyboard to your needs.
+Head over to [Customize your Dilemma firmware][use-dilemma] to customize your keyboard to your needs.
 
-If you need any help with it, make sure to hop on the discord : [bstkbd.com/discord](https://www.bstkbd.com/discord)
+---
+
+[use-dilemma]: {{site.baseurl}}/bg_dilemma/customize.html

bg_scylla/13customize.md

@@ -1,9 +1,9 @@
 ---
 layout: default
-title: Customizing your keyboard
+title: Using your keyboard
 nav_order: 13
 parent: Build guide - Scylla
 ---
 
 
-{% include customize_keyboard.md %}
+{% include use_keyboard.md %}

bg_skeletyl/13customize.md

@@ -1,9 +1,9 @@
 ---
 layout: default
-title: Customizing your keyboard
+title: Using your keyboard
 nav_order: 13
 parent: Build guide - Skeletyl
 ---
 
 
-{% include customize_keyboard.md %}
+{% include use_keyboard.md %}

faq.md

@@ -66,4 +66,4 @@ You can get those from Drop, or any other website that offers them.
 ---
 
 [bluetooth]: {{site.baseurl}}/help/bluetooth.html
-[customize]: {{site.baseurl}}/fw/customize-keyboard.html
+[customize]: {{site.baseurl}}/bg_charybdis/13customize.html