qmk-firmware/keyboards/yanghu/unicorne/readme.md

18 lines
1015 B
Markdown
Raw Normal View History

Add a new keyboard "Unicorne" (#12993) * Add keyboards/yanghu/unicorne initial files. * add default keymap to yanghu/unicorne * use slow i2c and enable internal pullup resistor * add oled to default keymaps * fix unicorne default keymap * fix encoder pad direction * fix marauder * add led matrix configs. * add encoder code to default keymap. * fix encoder direction * add readme, info.json and update copyright for c files. * fix build error by clean up include in unicorne.c * fix images in readme files * Fix various issues in PR #12993 feedback. * Added copyright in glcdfont, fix include in that file. * Removed `_kc` layout and renamed layout with generic style. * Moved capslock oled update to oled.c inside `oled_task_user()`. * Update keyboards/yanghu/unicorne/keymaps/default/rules.mk Always include oled.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yanghu/unicorne/keymaps/default/oled.c Wrap `oled.c` with ifdef. Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yanghu/unicorne/keymaps/default/oled.c Co-authored-by: Drashna Jaelre <drashna@live.com> * move oled code to unicorne.c, and set weakly. * Update keyboards/yanghu/unicorne/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yanghu/unicorne/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yanghu/unicorne/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yanghu/unicorne/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yanghu/unicorne/unicorne.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/yanghu/unicorne/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yanghu/unicorne/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yanghu/unicorne/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yanghu/unicorne/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yanghu/unicorne/keymaps/default/oled.c Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yanghu/unicorne/f411/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/yanghu/unicorne/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * remove oled.h * remove include of oled.h after the file is deleted. * Apply suggestions from code review: remove redundant macros and reformat. Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> * Apply suggestions from code review: change OLED driver macro. Use `OLED_ENABLE` instead of `OLED_DRIVER_ENABLE`. Co-authored-by: Jonathan Rascher <jon@bcat.name> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Jonathan Rascher <jon@bcat.name>
2021-11-05 10:10:15 +01:00
# Unicorne
![Unicorne](https://imgur.com/g1nN3b4h.jpg)
A compact 40% (3x6\_4) single-piece angled ortholinear ergo keyboard kit inspired by crkbd, Kyria, Ferris and Reviung41. Features OLED display, audio buzzer, RGB LED underglow as well as encoders.
* Keyboard Maintainer: [Yang Hu](https://github.com/yanghu)
* Hardware Supported: Unicorne PCB 1.0
* Hardware Availability: Open source design at https://github.com/yanghu/unicorne
To enter bootloader, long press the reset button for 3-5 seconds then release. More details can be found at [keyboard wiki](https://github.com/yanghu/unicorne/wiki/Build-guide#testing-the-board).
Make example for this keyboard (after setting up your build environment):
make yanghu/unicorne: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).