[Keyboard] Add Pulse 4k, a macropad by Maxr1998 (#6195)

[qmk_firmware.git] / keyboards / maxr1998 / pulse4k / readme.md

diff --git a/keyboards/maxr1998/pulse4k/readme.md b/keyboards/maxr1998/pulse4k/readme.md
new file mode 100644 (file)
index 0000000..3a55218
--- /dev/null
+++ b/keyboards/maxr1998/pulse4k/readme.md
@@ -0,0 +1,11 @@
+# Pulse 4k
+A four-key macropad with two rotary encoders, developed by Maxr1998, [fully open-source](https://github.com/Maxr1998/Pulse_4k).
+
+Keyboard Maintainer: [Maxr1998](https://github.com/Maxr1998)  
+Hardware Availability: DIY from the [open-source design files](https://github.com/Maxr1998/Pulse_4k), potential official distribution in the future
+
+Make example for this keyboard (after setting up your build environment):
+
+    make maxr1998/pulse4k: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).