From 7de6254625dd6baf953b3975a270513e5f7001e2 Mon Sep 17 00:00:00 2001 From: Victor Date: Wed, 2 Oct 2024 08:38:39 +0300 Subject: [PATCH] update readme --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cf4d41b..b8dfd98 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ manifest: path: config ``` -- Copy [the default keymap file](https://github.com/victorlucachi/zmk-keyboards-charybdis/blob/PR2477/boards/shields/charybdis/charybdis.keymap), create a new `config/charybdis.keymap` file, paste and edit to customize the keymap +- Copy [the contents of the default keymap file](https://github.com/victorlucachi/zmk-keyboards-charybdis/blob/PR2477/boards/shields/charybdis/charybdis.keymap), create a new `config/charybdis.keymap` file, paste and edit to customize the keymap - Edit the `build.yml` file and add the Charybdis to the build list: ``` @@ -64,6 +64,12 @@ include: ## Misc +#### Pointer Support + +This module is based on ZMK pointer [PR 2477](https://github.com/zmkfirmware/zmk/pull/2477), badjeff's [pmw3610 driver](https://github.com/badjeff/zmk-pmw3610-driver) and [peripheral input relay](https://github.com/badjeff/zmk-split-peripheral-input-relay). I highly suggest going over the documentation that is available in each of those repositories for a better understanding of their configuration options. + +#### ZMK Studio + The shield is ZMK Studio enabled; ZMK Studio is in early alpha, the web gui (works only with the central half connected via USB; for BLE Studio you have to use one of the ZMK Studio native apps available [here](https://github.com/zmkfirmware/zmk-studio/actions)) is available [here](https://main.alpha.zmk.studio/). ![Charybdis Nano - ZMK Studio](image.png)