summaryrefslogtreecommitdiff
path: root/keyboards/plywrks/lune/readme.md
diff options
context:
space:
mode:
authorRamon Imbao <ramonimbao@gmail.com>2022-08-24 01:55:59 +0800
committerGitHub <noreply@github.com>2022-08-23 10:55:59 -0700
commita53ef56946212cb8d71051c61b88b34c84e4430d (patch)
tree9dbef20318365fd8154c79e231169b7905b5a07c /keyboards/plywrks/lune/readme.md
parent78393966147bd7e862fd42ca0f0c3236ac45f10f (diff)
[Keyboard] Add Plywrks Lune (#17057)
* Add Plywrks Lune * Add OLED functionality * Update keyboards/plywrks/lune/keymaps/default/keymap.c * Update keyboards/plywrks/lune/keymaps/via/keymap.c * Update keyboards/plywrks/lune/keymaps/via/keymap.c * Update keyboards/plywrks/lune/lune.c * Add the missing 2 layers in the keymap Also added a missing parenthesis in lune.c, and removed the oled_task_user in the default keymap. * Update keyboards/plywrks/lune/info.json * Update keyboards/plywrks/lune/info.json * Update keyboards/plywrks/lune/info.json * Update keyboards/plywrks/lune/config.h
Diffstat (limited to 'keyboards/plywrks/lune/readme.md')
-rw-r--r--keyboards/plywrks/lune/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/plywrks/lune/readme.md b/keyboards/plywrks/lune/readme.md
new file mode 100644
index 0000000000..bab2356a45
--- /dev/null
+++ b/keyboards/plywrks/lune/readme.md
@@ -0,0 +1,21 @@
+# Lune
+
+![Lune](https://i.imgur.com/GgOzXRUl.jpg)
+
+Lune: a plateless, screwless ergonomic 60 percent with an OLED screen.
+Specs: 16.5mm front height, 5 degrees typing angle, interchangeable brass top, daughterboard
+
+* Keyboard Maintainer: [Ramon Imbao](https://github.com/ramonimbao)
+* Hardware Supported: ATmega32u4
+
+Make example for this keyboard (after setting up your build environment):
+
+ make plywrks/lune:default
+
+To get to the bootloader, simply press the reset button located on the back of the PCB. You can then flash new firmware onto it.
+
+Flashing example for this keyboard:
+
+ make plywrks/lune: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).