summaryrefslogtreecommitdiffstats
path: root/keyboards/akb/ogrn/readme.md
diff options
context:
space:
mode:
authorarnstadm <45672752+arnstadm@users.noreply.github.com>2022-08-13 04:46:16 +0200
committerGitHub <noreply@github.com>2022-08-12 19:46:16 -0700
commitaee48b8aabc8f9d0b7d11f0fa77879e40337d224 (patch)
tree12324eb599471711ad0ce7817ed85f0e44f46020 /keyboards/akb/ogrn/readme.md
parentfb150e08f1f87c05127d648c47a3fda455f3ecfa (diff)
[Keyboard] add ogrn (#17983)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/akb/ogrn/readme.md')
-rw-r--r--keyboards/akb/ogrn/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/akb/ogrn/readme.md b/keyboards/akb/ogrn/readme.md
new file mode 100644
index 0000000000..16d60538c7
--- /dev/null
+++ b/keyboards/akb/ogrn/readme.md
@@ -0,0 +1,27 @@
+# akb/ogrn
+
+![akb/ogrn](https://i.imgur.com/qbolyMal.png)
+
+Numpad for the OGR keyboard by AKB
+
+* Keyboard Maintainer: [akb](https://alchemistkeyboards.com/)
+* Hardware Supported: OGRN PCB
+* Hardware Availability: https://alchemistkeyboards.com/projects/keyboards/ogr/
+
+Make example for this keyboard (after setting up your build environment):
+
+ make akb/ogrn:default
+
+Flashing example for this keyboard:
+
+ make akb/ogrn: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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available