Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
victorlucachi authored Oct 2, 2024
1 parent ba81cc3 commit 7de6254
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 7de6254

Please sign in to comment.