From ee64eb5df82e110155eaf1f16d7a6c40cacf5be9 Mon Sep 17 00:00:00 2001 From: Victor Date: Thu, 12 Dec 2024 12:25:54 +0200 Subject: [PATCH] update readme --- README.md | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b8dfd98..6fa4b8a 100644 --- a/README.md +++ b/README.md @@ -4,31 +4,26 @@ - Open the following [link](https://github.com/zmkfirmware/unified-zmk-config-template), click the green `Use this template` button in the upper right corner, and create a new repository - Navigate to your newly created repository -- Edit the `config/west.yml` file and add the Charybdis module as well as the pmw3610 driver and peripheral input module, ZMK branch for pointer input: +- Edit the `config/west.yml` file and add the Charybdis module as well as the pmw3610 driver: ``` manifest: remotes: - name: zmkfirmware url-base: https://github.com/zmkfirmware - - name: petejohanson - url-base: https://github.com/petejohanson - name: badjeff url-base: https://github.com/badjeff projects: - name: zmk - remote: petejohanson - revision: feat/pointers-with-input-processors + remote: zmkfirmware + revision: main import: app/west.yml - name: zmk-pmw3610-driver remote: badjeff revision: main - - name: zmk-split-peripheral-input-relay - remote: badjeff - revision: main - name: zmk-keyboards-charybdis - url: https://github.com/victorlucachi/zmk-keyboards-charybdis - revision: PR2477 + url: zmk-keyboards-charybdis + revision: develop path: modules/zmk-keyboards-charybdis self: path: config @@ -64,10 +59,6 @@ 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/).