summaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/trackpoint/readme.md
diff options
context:
space:
mode:
authornoroadsleft <18669334+noroadsleft@users.noreply.github.com>2019-03-06 11:51:41 -0800
committerDrashna Jaelre <drashna@live.com>2019-03-06 11:51:41 -0800
commitbe8257f0a784a07e7dd93ecafe96c1d7774383f7 (patch)
tree0de394aec7f74f9e457f205954d9324163c32bd9 /keyboards/handwired/trackpoint/readme.md
parentda2eedc0c2587ee8d11ee94cb61e17b4e8717265 (diff)
[Keyboard] handwired/trackpoint: refactor and readme cleanup (#5325)
* handwired/trackpoint: refactor - layout macro KEYMAP renamed to LAYOUT - keymap now uses #include QMK_KEYBOARD_H * handwired/trackpoint: readme cleanup - fix wiring layout image URL - update readme structure * handwired/trackpoint: rename readme to lowercase * handwired/trackpoint: update header files to use #pragma once
Diffstat (limited to 'keyboards/handwired/trackpoint/readme.md')
-rw-r--r--keyboards/handwired/trackpoint/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/handwired/trackpoint/readme.md b/keyboards/handwired/trackpoint/readme.md
new file mode 100644
index 0000000000..e1302fbb7f
--- /dev/null
+++ b/keyboards/handwired/trackpoint/readme.md
@@ -0,0 +1,19 @@
+# IBM Trackpoint demonstration
+
+This is just a simple demo to show how to integrate IBM Trackpoint in QMK.
+
+Wiring used in the demonstration:
+![Wiring example](https://i.imgur.com/8ghG2U8.png)
+
+Some documentation:
+
+- [How to wire IBM Trackpoint](https://github.com/alonswartz/trackpoint)
+
+Keyboard Maintainer: [The QMK Community](https://github.com/qmk)
+Hardware Supported: Teensy
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/trackpoint: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).