Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
victorlucachi authored Dec 12, 2024
1 parent 6593a1c commit ee64eb5
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/).
Expand Down

0 comments on commit ee64eb5

Please sign in to comment.