summaryrefslogtreecommitdiffstats
path: root/keyboards/efreet/readme.md
diff options
context:
space:
mode:
authorAmber Holly <halcyonsilver@gmail.com>2019-09-25 21:06:57 +0100
committerDrashna Jaelre <drashna@live.com>2019-09-25 13:06:57 -0700
commit475f832b0f434615b9b32ca3f600c4b770d6e1e5 (patch)
tree34f7941509148d984e7debe8c3eb1ae4b15b9076 /keyboards/efreet/readme.md
parenta76a79b8275740e218a31e1e45ec22bfeb80d3ba (diff)
[Keyboard] Add Efreet keyboard (#6811)
* start wraith firmware * completed initial setup * added amber keymap to wraith * fixed LEDs, wrote readme files * reverted bootloader type after troubleshooting * decapitalised files and directory as per qmk standards * Update Wraith keyboard folder - Add timer keymap with documentation - Remove boilerplate in rules.mk, ready for pull request - Update info.json with ISO and ANSI layouts, ready for QMK Configurator * Add Efreet keyboard * Remove unnecessary keyboard folders * Enable community layout support for Efreet - Rename LAYOUT macro to LAYOUT_ortho_4x12 - Add layout macro named LAYOUT_planck_mit - Remove unnecessary magic key command, as we are using the default - Fix readme.md formatting for GitHub * Fix community layout support for Efreet - Fix 2u spacebar keycodes in LAYOUT_planck_mit to denote absence of switch - Turn on Community Layouts in rules.mk * Update default keymap.c to use community layout
Diffstat (limited to 'keyboards/efreet/readme.md')
-rw-r--r--keyboards/efreet/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/efreet/readme.md b/keyboards/efreet/readme.md
new file mode 100644
index 0000000000..9310dacf7b
--- /dev/null
+++ b/keyboards/efreet/readme.md
@@ -0,0 +1,15 @@
+# Efreet
+
+![efreet](https://i.imgur.com/Lh6WLuI.jpg)
+
+Custom PCB for the Efreet (as4x) keyboard.
+
+Keyboard Maintainer: [Amber Holly](https://github.com/amberstarlight)
+Hardware Supported: Efreet PCB
+Hardware Availability: private group buy
+
+Make example for this keyboard (after setting up your build environment):
+
+ make efreet: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).