diff options
Diffstat (limited to 'keyboards/dj505/picofx/readme.md')
| -rw-r--r-- | keyboards/dj505/picofx/readme.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/keyboards/dj505/picofx/readme.md b/keyboards/dj505/picofx/readme.md new file mode 100644 index 0000000000..3f72323d34 --- /dev/null +++ b/keyboards/dj505/picofx/readme.md | |||
| @@ -0,0 +1,34 @@ | |||
| 1 | # dj505/picofx | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | PicoFX: A compact keyboard-style controller for the *Pump It Up* rhythm game series. This firmware is intended for using the controller with the [Pump It Up Rise](https://store.steampowered.com/app/2756930/PUMP_IT_UP_RISE/) home version of the game. | ||
| 6 | |||
| 7 | * Hardware Supported: [PicoFX](https://github.com/dj505/PicoFX) | ||
| 8 | * Keyboard Maintainer: [jjc1138](https://github.com/jjc1138) | ||
| 9 | |||
| 10 | Make example for this keyboard (after setting up your build environment): | ||
| 11 | |||
| 12 | make dj505/picofx:default | ||
| 13 | |||
| 14 | Flashing example for this keyboard: | ||
| 15 | |||
| 16 | make dj505/picofx:default:flash | ||
| 17 | |||
| 18 | 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). | ||
| 19 | |||
| 20 | ## Keymaps | ||
| 21 | |||
| 22 | There are three keymaps provided, or you can build your own using the instructions below. | ||
| 23 | |||
| 24 | * [default](keymaps/default/readme.md) | ||
| 25 | * [menumode](keymaps/menumode/readme.md) | ||
| 26 | * [allinone](keymaps/allinone/readme.md) | ||
| 27 | |||
| 28 | ### Bootloader | ||
| 29 | |||
| 30 | Put the controller in bootloader mode in one of three ways: | ||
| 31 | |||
| 32 | * **Physical reset button**: Hold down the BOOTSEL button on the microcontroller when connecting the USB cable. | ||
| 33 | * **Bootmagic reset**: If a version of this firmware is already installed, hold down the top-left button on the keyboard when connecting the USB cable. | ||
| 34 | * **Keycode in keymap**: If a version of this firmware is already installed with the 'menumode' or 'allinone' keymap, hold down the Service button and press the Test button. Or press a button mapped to `QK_BOOT` in your own keymap. | ||
