From c63d9ee0d563228f1b5b7e1f1f54a5b541a90429 Mon Sep 17 00:00:00 2001 From: "Michael F. Lamb" Date: Sun, 26 Aug 2018 12:00:22 -0700 Subject: [PATCH] mitosis: minor readme improvements (#3762) * minor improvements to top-level mitosis keyboard readme * typo * trivial readme change --- keyboards/mitosis/keymaps/datagrok/readme.md | 2 +- keyboards/mitosis/readme.md | 25 ++++++++++++-------- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/keyboards/mitosis/keymaps/datagrok/readme.md b/keyboards/mitosis/keymaps/datagrok/readme.md index 176e0f411..9b159b98a 100644 --- a/keyboards/mitosis/keymaps/datagrok/readme.md +++ b/keyboards/mitosis/keymaps/datagrok/readme.md @@ -67,7 +67,7 @@ Keyboard layout editor sources: - I like the way Workman feels and some of its advantages over Colemak. Unfortunately, it was designed using a weighting system based on a standard - column-staggered keyboard so is probably not as optimal as one could achieve + row-staggered keyboard so is probably not as optimal as one could achieve on an ergonomic board like the Mitosis. Maybe run an optimizer routine after I determine good values for key difficulty on the Mitosis. diff --git a/keyboards/mitosis/readme.md b/keyboards/mitosis/readme.md index 0d5a74a1d..e1b071101 100644 --- a/keyboards/mitosis/readme.md +++ b/keyboards/mitosis/readme.md @@ -1,11 +1,12 @@ -Mitosis -======= +# Mitosis + +![Mitosis](https://i.imgur.com/JTzXTCD.jpg) A wireless split compact keyboard. -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/ +Keyboard Maintainer: [@reversebias](https://github.com/reversebias) +Hardware Supported: Mitosis PCB +Hardware Availability: See the [Mitosis keyboard announcement and discussion](https://www.reddit.com/r/MechanicalKeyboards/comments/66588f/wireless_split_qmk_mitosis/) Make example for this keyboard (after setting up your build environment): @@ -13,12 +14,16 @@ Make example for this keyboard (after setting up your build environment): 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. -## Mitosis Notes +## Notes -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. +Some circuit board manufacturers including [DirtyPCBs](https://dirtypcbs.com/) and [PCBWay](https://www.pcbway.com/) offer a steeply discounted "prototyping" rate for a small quantity of identical circuit boards less than 100x100mm in size. The Mitosis was designed to take advantage of this, so that individuals might affordably manufacture their own without waiting for a group-buy. -Build log of the keyboard can be found [here](https://www.reddit.com/r/MechanicalKeyboards/comments/66588f/wireless_split_qmk_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. -Hardware design files can be found [here](https://github.com/reversebias/mitosis-hardware) +This keyboard uses a completely different 'matrix scan' system than most other keyboards supported by QMK. Here, QMK runs in a Pro Micro on a receiver module, and communicates only with an nRF51822 microcontroller module that in turn does wireless communication. The nRF51822 maintains a matrix of keystates received from the same microcontrollers on each of the keyboard halves. The matrix.c file contains the code to make the Pro Micro poll the external wireless microcontroller for the key matrix. As long as this file is not changed, all other QMK features are supported. -Firmware for the nordic MCUs can be found [here](https://github.com/reversebias/mitosis) +[Mitosis keyboard build log](https://imgur.com/a/mwTFj), including many photos and notes about the assembly process. + +[Mitosis keyboard hardware design files](https://github.com/reversebias/mitosis-hardware), including PCB schematics and manufacturing files, parts list, and a laser-cutting template for the neoprene base. + +[Mitosis keyboard wireless firmware](https://github.com/reversebias/mitosis) for the Nordic microcontrollers.