summaryrefslogtreecommitdiff
path: root/keyboards/handwired/magicforce68/readme.md
diff options
context:
space:
mode:
authornoroadsleft <18669334+noroadsleft@users.noreply.github.com>2019-02-25 17:05:22 -0800
committerDrashna Jaelre <drashna@live.com>2019-02-25 17:05:22 -0800
commit303859ea284ebd08e305ac1bd907aee399f5a01d (patch)
treeedc6c8af5d452c5aeb4cc29e32532d0abdc41258 /keyboards/handwired/magicforce68/readme.md
parent65db4042603af6592b8433e384397eb880e5e1f5 (diff)
handwired/magicforce68: refactor, Configurator support, and readme cleanup (#5234)
* handwired/magicforce68: refactor - layout macro KEYMAP renamed to LAYOUT - keymap now uses #include QMK_KEYBOARD_H - keymap now uses non-auto-prepended keycodes per QMK standard. - deleted deprecated and unused action_get_macro block from default keymap. * handwired/magicforce68: Configurator support * handwired/magicforce68: readme cleanup - updated to current QMK template - rename file to lowercase - fix make commands - Add Docs links
Diffstat (limited to 'keyboards/handwired/magicforce68/readme.md')
-rw-r--r--keyboards/handwired/magicforce68/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/handwired/magicforce68/readme.md b/keyboards/handwired/magicforce68/readme.md
new file mode 100644
index 0000000000..5b5ade3b7f
--- /dev/null
+++ b/keyboards/handwired/magicforce68/readme.md
@@ -0,0 +1,24 @@
+# Magicforce 68 Handwired
+
+This firmware is for a Magicforce 68 that's had its PCB removed and is handwired with an Arduino Micro. NOTE: The Arduino Micro is different than the Arduino *Pro* Micro.
+
+Keyboard Maintainer: [The QMK Community](https://github.com/qmk)
+Hardware Supported: magicforce68, Arduino Micro
+
+## Wiring Layout
+
+![Wiring Layout](http://i.imgur.com/NmTCv5u.png)
+
+## Pinout
+
+The following pins are used:
+- Columns 1-15: B2, B0, D3, D2, D1, D0, D4, C6, D7, E6, B4, B5, B6, B7, D6
+- Rows 1-5: F0, F1, F4, F5, F6
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/magicforce68:default
+
+To flash the firmware onto the microcontroller, run `make handwired/magicforce68:default:avrdude`, and press the reset button.
+
+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).