diff options
Diffstat (limited to 'keyboards/splitography/readme.md')
| -rw-r--r-- | keyboards/splitography/readme.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/keyboards/splitography/readme.md b/keyboards/splitography/readme.md new file mode 100644 index 000000000..eeb9b2f40 --- /dev/null +++ b/keyboards/splitography/readme.md | |||
| @@ -0,0 +1,42 @@ | |||
| 1 | # Splitography | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | A *pay what you will* compact keyboard intended for use with [Plover](https://www.openstenoproject.org/), free and open source stenography software. This is a low-cost keyboard with minimal packaging and design, and arrives fully assembled, ready to use. | ||
| 6 | |||
| 7 | * Keyboard Maintainer: [The QMK Community](https://github.com/qmk) | ||
| 8 | * Hardware Supported: Splitography | ||
| 9 | * Hardware Availability: [softhruf.love](https://softhruf.love/collections/writers) | ||
| 10 | |||
| 11 | Make example for this keyboard (after setting up your build environment): | ||
| 12 | |||
| 13 | make splitography:default | ||
| 14 | |||
| 15 | Flashing example for this keyboard: | ||
| 16 | |||
| 17 | make splitography:default:flash | ||
| 18 | |||
| 19 | See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). | ||
| 20 | |||
| 21 | ## Bootloader | ||
| 22 | |||
| 23 | Enter the bootloader in 3 ways: | ||
| 24 | |||
| 25 | * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard. | ||
| 26 | * **Physical reset button**: Briefly press the button on the back of the PCB. | ||
| 27 | * **Keycode in layout**: Press the key mapped to `RESET` if it is available. | ||
| 28 | |||
| 29 | ## [Guide](https://softhruf.love/pages/guides) | ||
| 30 | |||
| 31 | [Splitography quick start video](https://www.youtube.com/watch?v=ru4cRQ2s_v0) | ||
| 32 | |||
| 33 | A short video guide on how to set up the SOFT/HRUF Splitography, a mechanical keyboard intended for use with [Plover](https://www.openstenoproject.org/plover/). | ||
| 34 | |||
| 35 | Here is a reference card for the standard keyboard layout: | ||
| 36 | |||
| 37 |  | ||
| 38 | |||
| 39 | * While holding down a colored thumb key, the matching colored functions/characters on the remaining keys can be pressed. | ||
| 40 | * Bottom edge keys are accessed by holding down both keys. | ||
| 41 | * Numlock locks in the Numpad layer. | ||
| 42 | * Alt and Shift pressed simultaneously to return to the standard layout. | ||
