summaryrefslogtreecommitdiff
path: root/keyboards/mf68_ble/README.md
diff options
context:
space:
mode:
authorHarshit Goel2017-12-03 10:34:22 +0530
committerJack Humbert2017-12-03 00:04:22 -0500
commit7730dc3e5c0ded70b2825af5de61c3660ebe29d2 (patch)
treeaf9e4cde7f8442d4f19af82a52e19ea6c9e22871 /keyboards/mf68_ble/README.md
parent0740e84d63fd51c892556f1746496802e26f9b99 (diff)
Magicforce68 now in bluetooth flavour (#2051)
* Added working code for mf68_ble * update read.md * update read.md * update read.md * update readme * Update README.md * Update README.md * added reddit post * Update README.md * Update README.md
Diffstat (limited to 'keyboards/mf68_ble/README.md')
-rw-r--r--keyboards/mf68_ble/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/mf68_ble/README.md b/keyboards/mf68_ble/README.md
new file mode 100644
index 000000000..3829c8fd7
--- /dev/null
+++ b/keyboards/mf68_ble/README.md
@@ -0,0 +1,27 @@
+MF68
+====
+
+Magicforce 68 with [replacement PCB](https://github.com/di0ib/tmk_keyboard/tree/master/keyboard/mf68) designed by [di0ib](https://github.com/di0ib).
+
+Keyboard Maintainer: [di0ib](http://www.40percent.club)
+Hardware Supported: [Feather 32u4 Bluefruit](https://learn.adafruit.com/adafruit-feather-32u4-bluefruit-le/)
+Please note: This is 32u4 and not M0
+Hardware Availability: [PCB files](https://github.com/di0ib/tmk_keyboard/tree/master/keyboard/mf68/pcb)
+[MF68 thicc case files](https://github.com/harshitgoel96/mf68-case-thicc)
+Story
+-----
+
+The story and the idea behind this mod is available on [my reddit post](https://www.reddit.com/r/MechanicalKeyboards/comments/7eiiht/guide_i_built_a_bluetooth_enabled_magicforce68_no/)
+
+Wiring
+------
+
+Below is how you wire the Feather to PCB
+
+![wire map](https://i.imgur.com/zYOjlTA.png)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mf68_ble:default
+
+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.