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

Simplify, update, detail keyboard customization #23

Merged
merged 53 commits into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
65f72d7
separate daily use and customize
bstiq Aug 1, 2024
b4cac0e
clean up
bstiq Aug 1, 2024
1d1170b
missing link
bstiq Aug 1, 2024
4f4e029
expand wordlist
Aug 1, 2024
60db80d
Update _includes/use_keyboard_chary.md
bstiq Aug 1, 2024
0b7014f
Update .wordlist.txt
bstiq Aug 1, 2024
01908d9
Remove todo
bstiq Aug 1, 2024
60e2ef6
Update compile-firmware.md
bstiq Aug 1, 2024
cfc760a
Update compile-firmware.md
bstiq Aug 1, 2024
300e62a
add userspace info draft
bstiq Aug 2, 2024
3965588
Update compile-firmware.md
bstiq Aug 2, 2024
75e94be
Update compile-firmware.md
bstiq Aug 2, 2024
9de023e
Update compile-firmware.md
bstiq Aug 2, 2024
493873a
remove miryoku mentions
bstiq Aug 2, 2024
d7b336e
Update _includes/use_keyboard.md
bstiq Aug 2, 2024
c439717
Update _includes/use_keyboard.md
bstiq Aug 2, 2024
6976463
Update _includes/use_keyboard_chary.md
bstiq Aug 2, 2024
55894e7
Update fw/compile-firmware.md
bstiq Aug 2, 2024
e3c138b
Update fw/compile-firmware.md
bstiq Aug 2, 2024
b9cad0a
Update .wordlist.txt
bstiq Aug 2, 2024
a2cb693
Update fw/compile-firmware.md
bstiq Aug 2, 2024
a7ecf07
Update compile-firmware.md
bstiq Aug 2, 2024
7d381fa
Update fw/compile-firmware.md
bstiq Aug 2, 2024
4f919be
Merge branch 'master' of https://github.com/bstiq/bstiqbstkbd.github.io
bstiq Aug 2, 2024
766c155
Update compile-firmware.md
bstiq Aug 2, 2024
ca3132c
typo
bstiq Aug 2, 2024
7518806
focus on userspace
bstiq Aug 2, 2024
4ed346a
Update .wordlist.txt
bstiq Aug 2, 2024
4f0fa67
Update fw/compile-firmware.md
bstiq Aug 2, 2024
1df7817
Update fw/compile-firmware.md
bstiq Aug 2, 2024
e97035a
Update fw/compile-firmware.md
bstiq Aug 2, 2024
64c28b0
Update fw/compile-firmware.md
bstiq Aug 2, 2024
423a814
Update .wordlist.txt
bstiq Aug 2, 2024
c8d3449
Merge branch 'master' of https://github.com/bstiq/bstiqbstkbd.github.io
bstiq Aug 2, 2024
e122e82
Update .wordlist.txt
bstiq Aug 2, 2024
1c18d4a
easier to understand wording
bstiq Aug 2, 2024
151afa9
separate github actions and local compile
bstiq Aug 4, 2024
af13aa6
Update .wordlist.txt
bstiq Aug 4, 2024
a92abbb
Update compile-firmware.md
bstiq Aug 4, 2024
6753af6
add lowercase keymap note
bstiq Aug 5, 2024
7222de5
more userspace links
bstiq Aug 5, 2024
5f7a144
clean up links
bstiq Aug 5, 2024
afb5f11
Update .wordlist.txt
bstiq Aug 6, 2024
cf2e742
Update .wordlist.txt
bstiq Aug 6, 2024
2dd92b1
Update fw/compile-firmware.md
bstiq Aug 6, 2024
b74fd6a
add releases link
bstiq Aug 6, 2024
675e0ab
Merge branch 'master' of https://github.com/bstiq/bstiqbstkbd.github.io
bstiq Aug 6, 2024
a19e2f2
update keymap argument
bstiq Aug 6, 2024
a850daf
Update fw/compile-firmware.md
bstiq Aug 6, 2024
ee92bf6
Update fw/compile-firmware.md
bstiq Aug 6, 2024
b9c48ea
Update fw/compile-firmware.md
bstiq Aug 6, 2024
ccf8d75
remove via stuff
bstiq Aug 6, 2024
00c4d8d
Merge branch 'master' of https://github.com/bstiq/bstiqbstkbd.github.io
bstiq Aug 6, 2024
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
8 changes: 7 additions & 1 deletion .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ TODO
multimeter
keypress
MCU
!dilemma
Dilemma
TRRS
KiCad
Millmax
Expand Down Expand Up @@ -94,3 +94,9 @@ udev

Singel
LEBASTARD

Alli # keeps getting detected as a word in youtube video id in embed
bstiq marked this conversation as resolved.
Show resolved Hide resolved
upstreaming
bstiq marked this conversation as resolved.
Show resolved Hide resolved
userspace
realpath
bstiq marked this conversation as resolved.
Show resolved Hide resolved
usevia # keeps being detected in the url
51 changes: 51 additions & 0 deletions _includes/use_keyboard.md
Original file line number Diff line number Diff line change
@@ -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
24 changes: 14 additions & 10 deletions _includes/customize_keyboard.md → _includes/use_keyboard_chary.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}
Expand All @@ -59,14 +62,15 @@ 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).
This is for advanced users.

For how to flash your keyboard, take a look at the [how to flash your keyboard page][flashing].
For how to compile a custom hardware for your keyboard, take a look at the [how to compile your own firmware page][compile-firmware].

For **advanced customization of the Charybdis and Charybdis Nano**, take a look at the [customize page][customize].
For **advanced customization of the Charybdis and Charybdis Nano**, take a look at the [customize page][customize-chary].

---

[customize]: {{site.baseurl}}/fw/charybdis-features.html
[customize-chary]: {{site.baseurl}}/fw/charybdis-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
4 changes: 2 additions & 2 deletions bg_charybdis/13customize.md
Original file line number Diff line number Diff line change
@@ -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 %}
4 changes: 2 additions & 2 deletions bg_cnano/13customize.md
Original file line number Diff line number Diff line change
@@ -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 %}
9 changes: 9 additions & 0 deletions bg_dilemma/customize.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: Using your Dilemma
nav_order: 99
parent: Build guide - Dilemma
---


{% include use_keyboard_chary.md %}
2 changes: 2 additions & 0 deletions bg_dilemma/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
10 changes: 0 additions & 10 deletions bg_dilemma/max_v1.md

This file was deleted.

3 changes: 1 addition & 2 deletions bg_dilemma/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
6 changes: 4 additions & 2 deletions bg_dilemma/v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions bg_scylla/13customize.md
Original file line number Diff line number Diff line change
@@ -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 %}
4 changes: 2 additions & 2 deletions bg_skeletyl/13customize.md
Original file line number Diff line number Diff line change
@@ -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 %}
Loading