diff options
Diffstat (limited to 'keyboards/phantom/readme.md')
| -rw-r--r-- | keyboards/phantom/readme.md | 48 |
1 files changed, 8 insertions, 40 deletions
diff --git a/keyboards/phantom/readme.md b/keyboards/phantom/readme.md index 614c21fda..7a31d106e 100644 --- a/keyboards/phantom/readme.md +++ b/keyboards/phantom/readme.md | |||
| @@ -1,48 +1,16 @@ | |||
| 1 | Phantom keyboard firmware | 1 | Phantom |
| 2 | ========================= | 2 | ======= |
| 3 | 3 | ||
| 4 | A community-developed keyboard PCB designed to fit inside the case of a Filco Majestouch. | 4 | A community-developed keyboard PCB designed to fit inside the case of a Filco Majestouch. |
| 5 | 5 | ||
| 6 | See the [Deskthority wiki](https://deskthority.net/wiki/Phantom) for more information. | 6 | See the [Deskthority wiki](https://deskthority.net/wiki/Phantom) for more information. |
| 7 | 7 | ||
| 8 | ## Bootloader | 8 | Keyboard Maintainer: QMK Community |
| 9 | Hardware Supported: Phantom PCB | ||
| 10 | Hardware Availability: https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=536 | ||
| 9 | 11 | ||
| 10 | The Phantom uses a [Teensy 2.0](https://www.pjrc.com/store/teensy.html) as a controller. | 12 | Make example for this keyboard (after setting up your build environment): |
| 11 | 13 | ||
| 12 | The Teensy has a special bootloader that can be accessed by pressing the button on the Teensy PCB. It is also possible to use Boot Magic and Command to access the bootloader. | 14 | make phantom-default |
| 13 | 15 | ||
| 14 | To write the firmware to the Teensy use [Teensy loader](https://www.pjrc.com/teensy/loader.html). | 16 | 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. |
| 15 | |||
| 16 | ## Quantum MK Firmware | ||
| 17 | |||
| 18 | For the full Quantum feature list, see the [documentation](https://docs.qmk.fm). | ||
| 19 | |||
| 20 | ## RGB underlight | ||
| 21 | |||
| 22 | It is possible to connect a WS2812B LED strip to the Teensy for RGB underlight support. | ||
| 23 | |||
| 24 | For this to work the DIN connection on the WS2812B strip should be soldered to PE2 on the Teensy (see reference image https://i.imgur.com/aDfNoHT.jpg). | ||
| 25 | |||
| 26 | See [rgbmod](keymaps/rgbmod) for a keymap that utilizes the RGB underlight feature. | ||
| 27 | |||
| 28 | ## Building | ||
| 29 | |||
| 30 | The Phantom allows for a huge amount of different layouts. | ||
| 31 | |||
| 32 | Depending on which layout and keymap you would like to use, you will have to compile the firmware slightly differently. All of the commands should be run in the [keyboards/phantom](/keyboards/phantom) folder. | ||
| 33 | |||
| 34 | ### Custom keymaps | ||
| 35 | |||
| 36 | To define your own keymap, copy one of the [existing keymap](keymaps) folders and give it the name of your keymap. Then check the [keymap documentation](https://docs.qmk.fm/Keymap.html) for details on how to modify the keymap. | ||
| 37 | |||
| 38 | To make it easy to define keymaps for the most common layouts a few macros are provided. | ||
| 39 | |||
| 40 | | Layout | Macro | | ||
| 41 | | --------------- | ------------------------- | | ||
| 42 | | Winkey ANSI | `KEYMAP()` | | ||
| 43 | | Winkeyless ANSI | `KEYMAP_WINKEYLESS()` | | ||
| 44 | | Winkey ISO | `KEYMAP_ISO()` | | ||
| 45 | | Winkeyless ISO | `KEYMAP_ISO_WINKEYLESS()` | | ||
| 46 | | 7BIT | `KEYMAP_7BIT()` | | ||
| 47 | |||
| 48 | To build the firmware with a custom keymap, run `make <keymap name>` | ||
