aboutsummaryrefslogtreecommitdiff
path: root/keyboards/phantom
diff options
context:
space:
mode:
authorMathias Andersson <wraul@dbox.se>2017-06-17 20:03:58 +0200
committerMathias Andersson <wraul@dbox.se>2017-06-23 12:07:18 +0200
commitdd9b00543b4fd08d851d91bd917615fc8fc0911e (patch)
tree8329ea06f21dc311ceeedf1222f691db4a61ad3e /keyboards/phantom
parent7ca335cf5b86e7d59de5daabeb75bea43d8f0ced (diff)
downloadqmk_firmware-dd9b00543b4fd08d851d91bd917615fc8fc0911e.tar.gz
qmk_firmware-dd9b00543b4fd08d851d91bd917615fc8fc0911e.zip
Update Phantom readme
Added basic description of the keyboard and some build and configuration instructions. Also moved the RGB underlight modification instructions to the readme.
Diffstat (limited to 'keyboards/phantom')
-rw-r--r--keyboards/phantom/pinout.txt1
-rw-r--r--keyboards/phantom/readme.md48
2 files changed, 46 insertions, 3 deletions
diff --git a/keyboards/phantom/pinout.txt b/keyboards/phantom/pinout.txt
deleted file mode 100644
index 415ad46d9..000000000
--- a/keyboards/phantom/pinout.txt
+++ /dev/null
@@ -1 +0,0 @@
1For WS2812B LED strip support, connect DIN from strip to PE2 on Teensy (see reference image https://i.imgur.com/aDfNoHT.jpg) \ No newline at end of file
diff --git a/keyboards/phantom/readme.md b/keyboards/phantom/readme.md
index 190f738fa..614c21fda 100644
--- a/keyboards/phantom/readme.md
+++ b/keyboards/phantom/readme.md
@@ -1,4 +1,48 @@
1Phantom keyboard firmware 1Phantom keyboard firmware
2====================== 2=========================
3 3
4TODO: to be updated. 4A community-developed keyboard PCB designed to fit inside the case of a Filco Majestouch.
5
6See the [Deskthority wiki](https://deskthority.net/wiki/Phantom) for more information.
7
8## Bootloader
9
10The Phantom uses a [Teensy 2.0](https://www.pjrc.com/store/teensy.html) as a controller.
11
12The 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.
13
14To write the firmware to the Teensy use [Teensy loader](https://www.pjrc.com/teensy/loader.html).
15
16## Quantum MK Firmware
17
18For the full Quantum feature list, see the [documentation](https://docs.qmk.fm).
19
20## RGB underlight
21
22It is possible to connect a WS2812B LED strip to the Teensy for RGB underlight support.
23
24For 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
26See [rgbmod](keymaps/rgbmod) for a keymap that utilizes the RGB underlight feature.
27
28## Building
29
30The Phantom allows for a huge amount of different layouts.
31
32Depending 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
36To 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
38To 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
48To build the firmware with a custom keymap, run `make <keymap name>`