diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..02b28e0 --- /dev/null +++ b/readme.md @@ -0,0 +1,30 @@ +<picture> + <source media="(prefers-color-scheme: dark)" srcset="/docs/images/TOTEM_logo_dark.svg"> + <source media="(prefers-color-scheme: light)" srcset="/docs/images/TOTEM_logo_bright.svg"> + <img alt="TOTEM logo font" src="/docs/images/TOTEM_logo_bright.svg"> +</picture> + +# ZMK CONFIG FOR THE TOTEM SPLIT KEYBOARD + +[Here](https://github.com/GEIGEIGEIST/totem) you can find the hardware files and build guide.\ +[Here](https://github.com/GEIGEIGEIST/qmk-config-totem) you can find the QMK config for the TOTEM. + +TOTEM is a 38 key column-staggered split keyboard running [ZMK](https://zmk.dev/) or [QMK](https://docs.qmk.fm/). It's meant to be used with a SEEED XIAO BLE or RP2040. + + + + + + +## HOW TO USE + +- fork this repo +- `git clone` your repo, to create a local copy on your PC (you can use the [command line](https://www.atlassian.com/git/tutorials) or [github desktop](https://desktop.github.com/)) +- adjust the totem.keymap file (find all the keycodes on [the zmk docs pages](https://zmk.dev/docs/codes/)) +- `git push` your repo to your fork +- on the GitHub page of your fork navigate to "Actions" +- scroll down and unzip the `firmware.zip` archive that contains the latest firmware +- connect the left half of the TOTEM to your PC, press reset twice +- the keyboard should now appear as a mass storage device +- drag'n'drop the `totem_left-seeeduino_xiao_ble-zmk.uf2` file from the archive onto the storage device +- repeat this process with the right half and the `totem_right-seeeduino_xiao_ble-zmk.uf2` file. \ No newline at end of file |