summaryrefslogtreecommitdiff
path: root/keyboards/pjb/eros/readme.md
diff options
context:
space:
mode:
authorPJB Keyboard Design <91110483+602studios@users.noreply.github.com>2022-04-13 00:04:14 -0700
committerGitHub <noreply@github.com>2022-04-13 00:04:14 -0700
commitdfe0515a4bfda7f291e2f051cf7fe3bb6a8e0f3a (patch)
treea78fb6b44817829d573badbe35f3781b09fc427c /keyboards/pjb/eros/readme.md
parent935af9e9996083c2b7e82f67072899e87c7f45ab (diff)
[Keyboard] Add Eros by PJB (#16756)
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'keyboards/pjb/eros/readme.md')
-rw-r--r--keyboards/pjb/eros/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/pjb/eros/readme.md b/keyboards/pjb/eros/readme.md
new file mode 100644
index 0000000000..b72f808dce
--- /dev/null
+++ b/keyboards/pjb/eros/readme.md
@@ -0,0 +1,20 @@
+# Eros
+
+TKL Custom Keyboard with F13 key
+
+* Keyboard Maintainer: [Phil](https://github.com/602studios)
+* Hardware Supported: Eros TKL PCB
+* Hardware Availability: [Geekhack Group Buy]( https://geekhack.org/index.php?topic=115569.0)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make pjb/eros/default
+
+Flashing example for this keyboard:
+
+ make pjb/eros/default:flash
+
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* while plugging in the keyboard.
+
+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).
+