diff options
Diffstat (limited to 'keyboards/mitosis/readme.md')
| -rw-r--r-- | keyboards/mitosis/readme.md | 37 |
1 files changed, 14 insertions, 23 deletions
diff --git a/keyboards/mitosis/readme.md b/keyboards/mitosis/readme.md index 70755e32ac..ef1eb0d832 100644 --- a/keyboards/mitosis/readme.md +++ b/keyboards/mitosis/readme.md @@ -1,33 +1,24 @@ -Mitosis Keyboard Firmware -====================== +Mitosis +======= -These configuration files were based off the Atreus keyboard. It assumes a Pro Micro is being used, however retains the 'make upload' feature from the Atreus branch. This keyboard uses a completely different 'matrix scan' system to other keyboards, it relies on an external nRF51822 microcontroller maintaining a matrix of keystates received from the keyboard halves. The matrix.c file contains the code to poll the external microcontroller for the key matrix. As long as this file is not changed, all other QMK features are supported. - -Build log of the keyboard can be found [here](https://www.reddit.com/r/MechanicalKeyboards/comments/66588f/wireless_split_qmk_mitosis/) +A wireless split compact keyboard. -Hardware design files can be found [here](https://github.com/reversebias/mitosis-hardware) - -Firmware for the nordic MCUs can be found [here](https://github.com/reversebias/mitosis) +Keyboard Maintainer: [@reversebias](https://github.com/reversebias] +Hardware Supported: Mitosis PCB +Hardware Availability: https://www.reddit.com/r/MechanicalKeyboards/comments/66588f/wireless_split_qmk_mitosis/ -## Quantum MK Firmware +Make example for this keyboard (after setting up your build environment): -For the full Quantum feature list, see [the parent readme](/). + make mitosis-default -## Building +See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. -Download or clone the whole firmware and navigate to the keyboards/atreus folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button. +## Mitosis Notes -Depending on which keymap you would like to use, you will have to compile slightly differently. - -### Default -To build with the default keymap, simply run `make default`. +These configuration files were based off the Atreus keyboard. It assumes a Pro Micro is being used, however retains the 'make upload' feature from the Atreus branch. This keyboard uses a completely different 'matrix scan' system to other keyboards, it relies on an external nRF51822 microcontroller maintaining a matrix of keystates received from the keyboard halves. The matrix.c file contains the code to poll the external microcontroller for the key matrix. As long as this file is not changed, all other QMK features are supported. -### Other Keymaps -Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files. +Build log of the keyboard can be found [here](https://www.reddit.com/r/MechanicalKeyboards/comments/66588f/wireless_split_qmk_mitosis/) -To build the firmware binary hex file with a keymap just do `make` with a keymap like this: +Hardware design files can be found [here](https://github.com/reversebias/mitosis-hardware) -``` -$ make [default|jack|<name>] -``` -Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. +Firmware for the nordic MCUs can be found [here](https://github.com/reversebias/mitosis) |