summaryrefslogtreecommitdiff
path: root/keyboards/drhigsby/bkf/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/drhigsby/bkf/readme.md')
-rw-r--r--keyboards/drhigsby/bkf/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/drhigsby/bkf/readme.md b/keyboards/drhigsby/bkf/readme.md
new file mode 100644
index 0000000000..18742920a4
--- /dev/null
+++ b/keyboards/drhigsby/bkf/readme.md
@@ -0,0 +1,21 @@
+# BKF - Base Kit Forty
+
+![BKF](https://i.imgur.com/3vR0yeW.png)
+
+BKF, Base Kit Forty, is a 40% style keyboard that is fully compatbile with a standard base kit of keycaps with 3 different spacebar configurations. It supports both standard R3 1.75u as well as stepped R3 1.75u on the left side. The key in the top right corner also sports rotary encoder support.
+
+* Keyboard Maintainer: [H. Bond](https://github.com/drhigsby)
+* Hardware Supported: BKF (https://github.com/drhigsby/bkf)
+* Hardware Availability: open-source stacked acrylic case design available at maintainer's github / make your own
+
+Make example for this keyboard (after setting up your build environment):
+
+ make drhigsby/bkf:default
+
+To place this keyboard into bootloader mode, press the reset button on the PCB or short the RST and GND pins on the pro micro.
+
+Flashing example for this keyboard:
+
+ make drhigsby/bkf:default:flash
+
+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).