summaryrefslogtreecommitdiff
path: root/keyboards/jorne/readme.md
diff options
context:
space:
mode:
authorjoric <joric@users.noreply.github.com>2021-12-16 13:28:29 +0500
committerGitHub <noreply@github.com>2021-12-16 19:28:29 +1100
commit42555157b8275c42857acfc076d5aa7f375f3b79 (patch)
tree9be63b5e4e7aac36a6f8531937320f7d491ce510 /keyboards/jorne/readme.md
parent231cd7a39fe91f31fadee94cf30c80d2587ca9fc (diff)
[Keyboard] Add Jorne (#15461)
* added jorne-dev (kyria-based) * updated files * raw logo * removed font * Fix after rebase on master: #undef SH_TG * Fix LTO parameter name. * Fix OLED. * Add VIA Jorne layout. * readme.md * updated jorne readme * Add info.json * Update keyboards/jorne/keymaps/default/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/jorne/keymaps/default/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/jorne/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/jorne/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/jorne/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * PR changes (added GPL headers, moved oled_task_user) * info.jsoon: fix thumbs poositions, reorder keys. * fix info.json maintainer * fixed layouts * Sync config.h for VIA with default keymap. * added post_config (sets brightness to 120 or it hangs) * added SPLIT_LAYER_STATE_ENABLE/SPLIT_LED_STATE_ENABLE * Update keyboards/jorne/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/jorne/rev1/config.h Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/jorne/keymaps/via/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/jorne/keymaps/default/keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/jorne/jorne.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/jorne/jorne.c Co-authored-by: Ryan <fauxpark@gmail.com> * fixed layout, removed unnecessary defines * vendor_id set to 0x4753 Co-authored-by: beta-tank <beta-tank@outlook.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/jorne/readme.md')
-rw-r--r--keyboards/jorne/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/jorne/readme.md b/keyboards/jorne/readme.md
new file mode 100644
index 0000000000..71c698e67e
--- /dev/null
+++ b/keyboards/jorne/readme.md
@@ -0,0 +1,25 @@
+# Jorne
+
+<img src="https://i.imgur.com/ywDcw2w.jpg" data-canonical-src="Jorne" width="600"/>
+
+Jorne is essentially [Corne](https://github.com/foostan/crkbd) but with an extra keys for brackets and international layouts (44 keys instead of 42).
+
+* Keyboard Maintainer: [joric](https://github.com/joric)
+* Hardware Supported: Jorne 2.1, 3.0
+* Layout: [keyboard-layout-editor.com](http://www.keyboard-layout-editor.com/#/gists/df19fba80500d1179dfda8c41b9f221a)
+* Hardware Availability: [wiki](https://github.com/joric/jorne/wiki)
+
+## Bootloader
+
+Enter the bootloader in 2 ways:
+
+* **Physical reset button**: Briefly press the reset button on the PCB
+* **Keycode in layout**: Press the key mapped to `RESET`
+
+## Make
+
+Make example for this keyboard (after setting up your build environment):
+
+ make jorne/rev1: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).