Skip to content

Commit 9159126

Browse files
bstiqbstiq
committed
2 parents 5b3254f + 2b47740 commit 9159126

22 files changed

+786
-123
lines changed

‎.wordlist.txt

+42-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ TODO
6060
multimeter
6161
keypress
6262
MCU
63-
!dilemma
63+
Dilemma
6464
TRRS
6565
KiCad
6666
Millmax
@@ -94,3 +94,44 @@ udev
9494

9595
Singel
9696
LEBASTARD
97+
98+
Alli # keeps getting detected as a word in youtube video id in embed
99+
upstreaming
100+
userspace
101+
realpath
102+
usevia # keeps being detected in the url
103+
104+
erenatas
105+
JLCPCB
106+
DDCR
107+
ROHS
108+
olidacombe's
109+
erenatas
110+
Perixx
111+
Aliexpress
112+
Flexstrip
113+
Microcontrollers
114+
keebs
115+
Hakko
116+
GALLUNOPTIMAL
117+
Pinecil
118+
scotto
119+
colemak
120+
inorichi
121+
petejohanson
122+
erenata's
123+
grassfedreeve
124+
nicenano
125+
SPDT
126+
Erenata
127+
128+
RMOD
129+
noeeprom
130+
eeprom
131+
drgscrl
132+
dragscroll
133+
reflash
134+
135+
hidraw
136+
uaccess
137+
udevadm

‎_includes/use_keyboard.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Table of contents
2+
3+
1. TOC
4+
{:toc}
5+
6+
# Introduction
7+
8+
Congratulations on successfully building your keyboard!
9+
10+
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.
11+
12+
# Daily use
13+
14+
## Default keymap
15+
16+
You can find pictures of the default keymaps on the [default keymaps page][keymaps].
17+
18+
Alternatively, you can also plug in your keyboard and visualize the keymap using VIA (see VIA section).
19+
20+
# Customization
21+
22+
For customizing your keyboard, you can:
23+
24+
- use VIA
25+
- use QMK
26+
27+
## Using VIA
28+
29+
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.
30+
31+
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).
32+
33+
You can check the following tutorial on how to use it:
34+
{% include youtube.html id="cYICAlliJfU" %}
35+
36+
Through VIA, you can customize:
37+
- the keymap
38+
- macros, layers
39+
- RGB
40+
41+
## Using QMK
42+
43+
This is for advanced users.
44+
45+
For how to compile a custom hardware for your keyboard, take a look at the [how to compile your own firmware page][compile-firmware].
46+
47+
---
48+
49+
[compile-firmware]: {{site.baseurl}}/fw/compile-firmware.html
50+
[keymaps]: {{site.baseurl}}/fw/default-keymaps.html
51+
[flashing]: {{site.baseurl}}/fw/flashing.html

‎_includes/customize_keyboard.md ‎_includes/use_keyboard_chary.md

+16-11
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,23 @@ The most important ones are on the thumb cluster - it transforms into mouse butt
3434

3535
### Sniping
3636

37-
Sniping **slows down the trackball**. This way, you can move the cursor more precisely.
37+
Sniping **slows down the trackball/trackpad**. This way, you can move the cursor more precisely.
3838

3939
By default, Sniping mode is activated when you hold the `MOUSE + SNIP` keys at the same time.
4040
You can also configure qmk to have it activated automatically.
4141

42-
## Miryoku
42+
# Customization
4343

44-
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.
44+
For customizing your keyboard, you can:
4545

46-
# Customization
46+
- use VIA
47+
- use QMK
4748

4849
## Using VIA
4950

50-
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).
51+
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.
52+
53+
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).
5154

5255
You can check the following tutorial on how to use it:
5356
{% include youtube.html id="cYICAlliJfU" %}
@@ -59,14 +62,16 @@ Through VIA, you can customize:
5962

6063
## Using QMK
6164

62-
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).
63-
64-
For how to flash your keyboard, take a look at the [how to flash your keyboard page][flashing].
65+
This is for advanced users.
6566

66-
For **advanced customization of the Charybdis and Charybdis Nano**, take a look at the [customize page][customize].
67+
- how to compile a custom hardware for your keyboard: [how to compile your own firmware][compile-firmware].
68+
- advanced customization of the Charybdis (and smaller variants): [customize your Charybdis][customize-chary].
69+
- advanced customization of the Dilemma (and smaller variants): [customize your Dilemma][customize-dilemma].
6770

6871
---
6972

70-
[customize]: {{site.baseurl}}/fw/charybdis-features.html
73+
[customize-chary]: {{site.baseurl}}/fw/charybdis-features.html
74+
[customize-dilemma]: {{site.baseurl}}/fw/dilemma-features.html
7175
[keymaps]: {{site.baseurl}}/fw/default-keymaps.html
72-
[flashing]: {{site.baseurl}}/fw/flashing.html
76+
[flashing]: {{site.baseurl}}/fw/flashing.html
77+
[compile-firmware]: {{site.baseurl}}/fw/compile-firmware.html

‎assets/pics/bluetooth/battery.jpg

200 KB
Loading

‎assets/pics/bluetooth/branch_names.png

43.7 KB
Loading

‎assets/pics/bluetooth/nano_holder.jpg

80.7 KB
Loading

‎bg_charybdis/13customize.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: default
3-
title: Customizing your keyboard
3+
title: Using your keyboard
44
nav_order: 13
55
parent: Build guide - Charybdis
66
---
77

88

9-
{% include customize_keyboard.md %}
9+
{% include use_keyboard_chary.md %}

‎bg_cnano/13customize.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: default
3-
title: Customizing your keyboard
3+
title: Using your keyboard
44
nav_order: 13
55
parent: Build guide - Charybdis Nano
66
---
77

88

9-
{% include customize_keyboard.md %}
9+
{% include use_keyboard_chary.md %}

‎bg_dilemma/customize.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
layout: default
3+
title: Using your Dilemma
4+
nav_order: 99
5+
parent: Build guide - Dilemma
6+
---
7+
8+
9+
{% include use_keyboard_chary.md %}

‎bg_dilemma/intro.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,7 @@ We recommend you start by reading the *required tools* section.
1111

1212
There are written guides, and there are also video guides in the *video guides* section.
1313

14+
For building the Dilemma MAX, just follow the Dilemma instructions - it's the same keyboard, just bigger.
15+
1416
1. TOC
1517
{:toc}

‎bg_dilemma/max_v1.md

-10
This file was deleted.

‎bg_dilemma/v1.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,5 @@ Solder in your switches of preference.
108108

109109
You're all done!
110110

111-
Head over to [bstkbd.com/custom](https://bstkbd.com/custom) to customize your keyboard to your needs.
111+
Head over to [Customize your Dilemma firmware][use-dilemma] to customize your keyboard to your needs.
112112

113-
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

+4-2
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,8 @@ Solder in your switches of preference.
120120

121121
You're all done!
122122

123-
Head over to [bstkbd.com/custom](https://bstkbd.com/custom) to customize your keyboard to your needs.
123+
Head over to [Customize your Dilemma firmware][use-dilemma] to customize your keyboard to your needs.
124124

125-
If you need any help with it, make sure to hop on the discord : [bstkbd.com/discord](https://www.bstkbd.com/discord)
125+
---
126+
127+
[use-dilemma]: {{site.baseurl}}/bg_dilemma/customize.html

‎bg_scylla/13customize.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: default
3-
title: Customizing your keyboard
3+
title: Using your keyboard
44
nav_order: 13
55
parent: Build guide - Scylla
66
---
77

88

9-
{% include customize_keyboard.md %}
9+
{% include use_keyboard.md %}

‎bg_skeletyl/13customize.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: default
3-
title: Customizing your keyboard
3+
title: Using your keyboard
44
nav_order: 13
55
parent: Build guide - Skeletyl
66
---
77

88

9-
{% include customize_keyboard.md %}
9+
{% include use_keyboard.md %}

‎faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,4 @@ You can get those from Drop, or any other website that offers them.
6666
---
6767

6868
[bluetooth]: {{site.baseurl}}/help/bluetooth.html
69-
[customize]: {{site.baseurl}}/fw/customize-keyboard.html
69+
[customize]: {{site.baseurl}}/bg_charybdis/13customize.html

0 commit comments

Comments
 (0)