Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aroum committed Sep 7, 2023
1 parent 1f7ad54 commit 9712a51
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,34 @@
# zmk-proXiao

## Corne

ZMK config fo proXiao shields.


proXiao is a bluetooth controller for:

* Corne
* Jorne
* Enki42
* Fifi
* Lily58
* Sofle
* reviung41
* [Corne](https://github.com/aroum/proXiao/tree/corne)
* [Jorne](https://github.com/aroum/proXiao/tree/jorne)
* [Enki42](https://github.com/aroum/proXiao/tree/enki42)
* [Fifi](https://github.com/aroum/proXiao/tree/fifi)
* [Lily58](https://github.com/aroum/proXiao/tree/lily58)
* [Sofle](https://github.com/aroum/proXiao/tree/sofle)
* [reviung41](https://github.com/aroum/proXiao/tree/reviung41)

Support for Lily58, Sofle, reviung41 is implemented only on PCB v3.
Support for Lily58, Sofle, reviung41 is implemented only on PCB v3. Screens and backlight are not supported. FTo support encoders, you need PCB v3 and solder an additional wire.

---

By switching between branches in this repository, you can choose the configuration for your keyboard. For a Corne or other compatible 6-column keyboard, you should select the ```corne``` branch.

If you have problems, flash the firmware to clear the settings from the branch ```setting-reset```.
If you have problems, flash the firmware to clear the settings from the branch [setting-reset](https://github.com/aroum/proXiao/tree/setting-reset).

You can change the device name in file ```config/proXiao.conf``` in line
```
CONFIG_ZMK_KEYBOARD_NAME="proXiao"
```

---

Pre-build firmware can be downloaded in the [releases](https://github.com/aroum/proXiao/releases).

0 comments on commit 9712a51

Please sign in to comment.