aboutsummaryrefslogtreecommitdiff
path: root/keyboards/crypt_macro/readme.md
diff options
context:
space:
mode:
authoryiancar <[email protected]>2022-12-12 23:47:08 +0000
committerGitHub <[email protected]>2022-12-12 15:47:08 -0800
commit89399b54949fdbbd6198ba87b7a05d1f44777499 (patch)
tree9c87001e3755c4a566e07bc641efd264f9b5e8df /keyboards/crypt_macro/readme.md
parent15ef0a7e3c178a1c2e1dbee0165ccee2545205ff (diff)
downloadqmk_firmware-89399b54949fdbbd6198ba87b7a05d1f44777499.tar.gz
qmk_firmware-89399b54949fdbbd6198ba87b7a05d1f44777499.zip
[Keyboard] Crypt Macro (#19279)
Co-authored-by: yiancar <[email protected]>
Diffstat (limited to 'keyboards/crypt_macro/readme.md')
-rw-r--r--keyboards/crypt_macro/readme.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/keyboards/crypt_macro/readme.md b/keyboards/crypt_macro/readme.md
new file mode 100644
index 0000000000..287f236e51
--- /dev/null
+++ b/keyboards/crypt_macro/readme.md
@@ -0,0 +1,32 @@
+# Crypt Macro
+
+This is a macropad PCB. It supports VIA.
+
+* Keyboard Maintainer: [Yiancar](http://yiancar-designs.com/) and on [GitHub](https://github.com/yiancar)
+* Hardware Supported: A macropad with STM32F072CB
+* Hardware Availability: https://www.nzcaps.com/
+
+## Instructions
+
+### Build
+
+Make example for this keyboard (after setting up your build environment):
+
+ make crypt_macro: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).
+
+### Reset
+
+- Unplug
+- Hold top left key
+- Plug In
+- Unplug
+- Release Escape
+
+### Flash
+
+- Unplug
+- Hold top left key
+- Plug In
+- Flash using QMK Toolbox or CLI (`make crypt_macro:<keymap>:flash`)