Update README.md

This commit is contained in:
He4eT 2025-05-12 10:59:47 +02:00
commit d353c67cf3

View file

@ -1,6 +1,10 @@
# Cantor MX Tastatura # Cantor MX Tastatura
It's my personal layout for the [custom build](https://gitea.dmz.rs/Decentrala/cantor) of the [Cantor MX Keyboard](https://github.com/diepala/cantor) by the [Decentrala comunity](https://decentrala.org/). [Cantor MX Keyboard](https://github.com/diepala/cantor) by the [Decentrala comunity](https://decentrala.org/).
Additional firmware for the 8MHz version of Blackpill_f411 provided by the [Xecut hackspace](https://xecut.me).
Vial supported.
![Overview](/images/photos/overview.jpg?raw=true) ![Overview](/images/photos/overview.jpg?raw=true)
![Overview Alternative](/images/photos/overview_alt.jpg?raw=true) ![Overview Alternative](/images/photos/overview_alt.jpg?raw=true)
@ -8,51 +12,61 @@ It's my personal layout for the [custom build](https://gitea.dmz.rs/Decentrala/c
## Initial Flash ## Initial Flash
- Clone the Vial repository: 1. Clone this repository:
``` ```
git clone --recurse-submodules git@github.com:vial-kb/vial-qmk.git git clone --recurse-submodules git@github.com:He4eT/cantor-mx-tastatura.git
cd vial-qmk cd cantor-mx-tastatura
``` ```
- Connect the controller to your computer using a USB cable 2. Connect the **left** controller to your computer using a USB cable.
- Update configs: 3. Start flashing proccess (Docker required):
- **Blackpill (f411), 8MHz** - For **8MHz Blackpill_f411** controllers:
- Replace content of the `vial-qmk/keyboards/cantor` with files from `./config/cantor/`.
- **Blackpill, 25MHz**
- **Optional**: add `#define EE_HANDS` in `vial-qmk/keyboards/cantor/keymaps/vial/config.h`
- Start the flashing process for the controller (Docker required):
- With EE_HANDS in config (each half respectively):
``` ```
sudo util/docker_build.sh cantor:vial:dfu-util-split-left make flash blackpill=f411-8mhz half=left
sudo util/docker_build.sh cantor:vial:dfu-util-split-right
``` ```
- Without EE_HANDS in config (left half will be the master half): - Otherwise:
``` ```
sudo util/docker_build.sh cantor:vial:flash make flash half=left
``` ```
- Use the onboard BOOT0 and NRST button to put the board into bootloader mode: 4. Use the onboard `BOOT0` and `NRST` button to put the board into bootloader mode:
- press and hold the BOOT0 button - press and hold the `BOOT0` button;
- press and release NRST (reset) button to power cycle the processor - press and release the `NRST` (Reset) button to power cycle the processor;
- release BOOT0 button - release the `BOOT0` button;
- For additional details, refer to: [STM32 Black Pill](https://land-boards.com/blwiki/index.php?title=STM32_Black_Pill) - For additional details, refer to [STM32 Black Pill](https://land-boards.com/blwiki/index.php?title=STM32_Black_Pill);
- Repeat the flashing process for the second controller. 5. Repeat the process from step 2 for the **right** half.
- Download the Vial configurator: https://get.vial.today/ 6. Download the [Vial configurator](https://get.vial.today/).
- **Linux Only**: Configure udev rules for the first launch: https://get.vial.today/manual/linux-udev.html 7. **Linux Only**: Configure [udev rules](https://get.vial.today/manual/linux-udev.html) for the first launch.
- Open the Vial configurator. 8. Open the Vial configurator.
9. **Optional**: Load a layout from `./layouts/`.
## Layout ## Layouts
### Base Layer ### Default
By default, the [Cantor Vial layout](https://github.com/vial-kb/vial-qmk/blob/vial/keyboards/cantor/keymaps/vial/keymap.c)
from the [vial-qmk](https://github.com/vial-kb/vial-qmk/) repository is used.
### My own layout
```
./layouts/odd_cantor_tastatura.vil
```
#### Base Layer
![Base Layer](/images/layers/layer_0.png?raw=true) ![Base Layer](/images/layers/layer_0.png?raw=true)
### Right Hand Layer #### Right Hand Layer
![Left Hand Layer](/images/layers/layer_1.png?raw=true) ![Left Hand Layer](/images/layers/layer_1.png?raw=true)
### Left Hand Layer #### Left Hand Layer
![Right Hand Layer](/images/layers/layer_2.png?raw=true) ![Right Hand Layer](/images/layers/layer_2.png?raw=true)
### Mouse Layer #### Mouse Layer
![Mouse Layer](/images/layers/layer_3.png?raw=true) ![Mouse Layer](/images/layers/layer_3.png?raw=true)
## Case ## Case
The [Cantor MX Slim Case](https://www.printables.com/model/996711-cantor-mx-slim-case) is a remix of the [Cantor MX Case](https://www.printables.com/model/707238-cantor-mx-case) by [@JellyTitan](https://www.printables.com/@JellyTitan). ```
./things/case_slim.stl
```
The [Cantor MX Slim Case](https://www.printables.com/model/996711-cantor-mx-slim-case) is
a remix of the [Cantor MX Case](https://www.printables.com/model/707238-cantor-mx-case) by [@JellyTitan](https://www.printables.com/@JellyTitan).