summaryrefslogtreecommitdiff
path: root/keyboards/ncc1701kb/readme.md
diff options
context:
space:
mode:
authorJesse Leventhal <45154268+jessel92@users.noreply.github.com>2020-01-07 17:29:45 -0500
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2020-01-07 14:29:45 -0800
commit0c86cfeaed23377862356326c0f26191f74d899f (patch)
tree845044fda9e3592fcffb325a2d4e10d2c2f72a73 /keyboards/ncc1701kb/readme.md
parentb69457a192374522de9662a219165ddfdd83afc2 (diff)
[Keyboard] Added NCC-1701-KB 3x3 Keypad with Encoder and Keymap (#7819)
* Added NCC-1701-KB Keypad and Keymap * Update keyboards/ncc1701kb/config.h * Update keyboards/ncc1701kb/config.h * Update keyboards/ncc1701kb/config.h * Update keyboards/ncc1701kb/config.h * Update keyboards/ncc1701kb/ncc1701kb.h * Update keyboards/ncc1701kb/readme.md * Update keyboards/ncc1701kb/readme.md * Update keyboards/ncc1701kb/readme.md * Fixed changes rules.mk bootloader * Fixed rules.mk Build Options * Recomended fauxpark changes/fixes * Update keyboards/ncc1701kb/ncc1701kb.h * Update keyboards/ncc1701kb/ncc1701kb.h * Update keyboards/ncc1701kb/readme.md * Update keyboards/ncc1701kb/readme.md
Diffstat (limited to 'keyboards/ncc1701kb/readme.md')
-rw-r--r--keyboards/ncc1701kb/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/ncc1701kb/readme.md b/keyboards/ncc1701kb/readme.md
new file mode 100644
index 0000000000..4e9ece7532
--- /dev/null
+++ b/keyboards/ncc1701kb/readme.md
@@ -0,0 +1,17 @@
+# NCC-1701-KB Keypad with Encoder
+
+![NCC-1701-KB PCB](https://i.imgur.com/aXFgH52.jpg)
+![NCC-1701-KB](https://i.imgur.com/9hWyhcR.jpg)
+
+The NCC-1701-KB Keypad is a custom Star Trek-inspired 3x3 mechanical keypad with an encoder knob.
+
+* Keyboard Maintainer: [J2L Designs](https://github.com/jessel92)
+* Hardware Supported: NCC-1701-KB PCB, ATmega32U4
+* Hardware Availability: [J2L Designs Store](https://www.etsy.com/listing/752039967/ncc-1701-kb-custom-star-trek-inspired)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ncc1701kb:default
+
+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).