summaryrefslogtreecommitdiffstats
path: root/keyboards/keyprez/corgi/readme.md
diff options
context:
space:
mode:
authorChristian Sandven <christian.sandven@kindly.ai>2021-05-27 07:25:51 +0200
committerGitHub <noreply@github.com>2021-05-26 22:25:51 -0700
commit088c71b4ea6e083f01d6c5d7248555972c4125a4 (patch)
treeb3c0c865e32964b8476542105120d19e56521c52 /keyboards/keyprez/corgi/readme.md
parent7e14f85dd50e3d0ec04fd6a7a5dc6549b79c0767 (diff)
[Keyboard] Corgi keyboard (#12311)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/keyprez/corgi/readme.md')
-rw-r--r--keyboards/keyprez/corgi/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/keyprez/corgi/readme.md b/keyboards/keyprez/corgi/readme.md
new file mode 100644
index 0000000000..73387964af
--- /dev/null
+++ b/keyboards/keyprez/corgi/readme.md
@@ -0,0 +1,22 @@
+# corgi
+
+![corgi](https://i.imgur.com/XctcpVrh.jpeg)
+
+Corgi is a semi modular 4 x 12 ortho keyboard. The unique thing with Corgi is that you can attach a macropad name "Flea" to use as a num/macro-pad.
+
+* Keyboard Maintainer: [Christian Sandven](https://github.com/csandven)
+* Hardware Supported: Pro Micro or Elite C is required
+* Hardware Availability: TBA
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keyprez/corgi:default
+
+Flashing example for this keyboard:
+
+ make keyprez/corgi:default:flash
+
+
+After running the flash command, you need to short reset and ground on your microcontroller to flash it.
+
+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).