mirrors/opensteno_qmk
1
0
Fork 0
mirror of https://github.com/openstenoproject/qmk synced 2024-11-12 19:44:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added license and readme

Browse source
This commit is contained in:
Akaash Suresh 2020-01-02 12:13:39 -06:00
parent 3650d59afe
commit a0a6e24788
2 changed files with 43 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
users/curry/LICENSE.md Normal file
View file

@ -0,0 +1,14 @@
Copyright 2020 Akaash Suresh casa.akaash@gmail.com @CurryFurious
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

29
users/curry/README.md Normal file
View file

@ -0,0 +1,29 @@
# Information
These is my userspace files, heavily influenced by @drashna's userspace structure.
Main uses are for corne & lily58, supporting dfu bootloader (elite-c)
# Keyboards
## Split Common
Is compatible with split_common when the previous two keyboards update to them.
If you want to use these keymaps with split common code, they are on my personal github fork: [CurryFurous/qmk_firmware](https://github.com/CurryFurious/qmk_firmware)
Referenced PRs: #6260, #5998, #6001
## Keymaps
Keymap layout is similar between the two keyboards. Lily 58 has a lot of open keys for custom keys as well. Keymap formatting is set up in the physical layout of the keyboard, so mapping keys should be easier.
## Tap Dances
Tap dances are enabled but none are defined, you can add them to [tapdances.c](tapdances.c). If not using tapdances, you can disable them in the keymaps.
## RGB
RGB is implemented pretty much the same as @drashna. Only change is that I added the RGB code from the drashna's corne [keymap.c](../../keyboards/crkbd/keymaps/drashna/keymap.c), lines 313-383 into rgb_stuff.c.
## OLED
Similarly to RGB, I moved all OLED code into [oled.c](oled.c) to better clear up the keymap.c file. I haven't experimented with the kyria's 128x64 pixel screen so it probably won't work as well with it yet.
## Wrappers
Have implemented QWERTY, COLEMAK Mod DH, and DVORAK. Other macros are defined, some modified from drashna's. Drashna's [wrappers.h](../drashna/wrappers.h) has other layouts that you can copy in as you see fit, make sure to add them to the userspace_layers enum in [curry.h](curry.h)