From d353c67cf35209e0fb7da63834ebb4e99f6592f7 Mon Sep 17 00:00:00 2001 From: He4eT Date: Mon, 12 May 2025 10:59:47 +0200 Subject: [PATCH] Update README.md --- README.md | 76 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 45 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 1929dfd..ed697ee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # 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 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 -- Clone the Vial repository: +1. Clone this repository: ``` - git clone --recurse-submodules git@github.com:vial-kb/vial-qmk.git - cd vial-qmk + git clone --recurse-submodules git@github.com:He4eT/cantor-mx-tastatura.git + cd cantor-mx-tastatura ``` -- Connect the controller to your computer using a USB cable -- Update configs: - - **Blackpill (f411), 8MHz** - - 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): +2. Connect the **left** controller to your computer using a USB cable. +3. Start flashing proccess (Docker required): + - For **8MHz Blackpill_f411** controllers: ``` - sudo util/docker_build.sh cantor:vial:dfu-util-split-left - sudo util/docker_build.sh cantor:vial:dfu-util-split-right + make flash blackpill=f411-8mhz half=left ``` - - 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: - - press and hold the BOOT0 button - - press and release NRST (reset) button to power cycle the processor - - release BOOT0 button - - 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. -- 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 -- Open the Vial configurator. +4. Use the onboard `BOOT0` and `NRST` button to put the board into bootloader mode: + - press and hold the `BOOT0` button; + - press and release the `NRST` (Reset) button to power cycle the processor; + - release the `BOOT0` button; + - For additional details, refer to [STM32 Black Pill](https://land-boards.com/blwiki/index.php?title=STM32_Black_Pill); +5. Repeat the process from step 2 for the **right** half. +6. Download the [Vial configurator](https://get.vial.today/). +7. **Linux Only**: Configure [udev rules](https://get.vial.today/manual/linux-udev.html) for the first launch. +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) -### Right Hand Layer +#### Right Hand Layer ![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) -### Mouse Layer +#### Mouse Layer ![Mouse Layer](/images/layers/layer_3.png?raw=true) ## 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).