add correct prepare & make instructions

This commit is contained in:
Frieder Schlesier 2022-06-13 13:21:38 +02:00
parent 9f2b136557
commit e3a133eaf7
4 changed files with 78 additions and 20 deletions

View File

@ -26,9 +26,12 @@ This is modified for my personal environment with i3wm + Spacemacs.
** Build and run ** Build and run
- git clone Kaleidoscope - ~git clone Kaleidoscope -d ${HOME}/projects/Kaleidoscope~
- export KALEIDOSCOPE - ~sudo cp ${HOME}/projects/Kaleidoscope/etc/60-kaleidoscope.rules /etc/udev/rules.d/~
- make flash - ~sudo udevadm trigger~
- cd Kaleidoscope/plugins && git clone https://github.com/keyboardio/Kaleidoscope-Languages
- export KALEIDOSCOPE_DIR=${HOME}/projects/Kaleidoscope
- cd ./colemak-dhm/ && make flash
** TODO ** TODO

45
colemak-dhm/Makefile Normal file
View File

@ -0,0 +1,45 @@
# This makefile for a Kaleidoscope sketch pulls in all the targets
# required to build the example
ifneq ($(KALEIDOSCOPE_DIR),)
search_path += $(KALEIDOSCOPE_DIR)
endif
ifneq ($(ARDUINO_DIRECTORIES_USER),)
search_path += $(ARDUINO_DIRECTORIES_USER)/hardware/keyboardio/avr/libraries/Kaleidoscope
endif
ifeq ($(shell uname -s),Darwin)
search_path += $(HOME)/Documents/Arduino/hardware/keyboardio/avr/libraries/Kaleidoscope
else
search_path += $(HOME)/Arduino/hardware/keyboardio/avr/libraries/Kaleidoscope
endif
sketch_makefile := etc/makefiles/sketch.mk
$(foreach candidate, $(search_path), $(if $(wildcard $(candidate)/$(sketch_makefile)), $(eval ks_dir ?= $(candidate))))
ifneq ($(ks_dir),)
$(info Using Kaleidoscope from $(ks_dir))
export KALEIDOSCOPE_DIR := $(ks_dir)
include $(ks_dir)/$(sketch_makefile)
else
$(info I can't find your Kaleidoscope installation.)
$(info )
$(info I tried looking in:)
$(info )
$(foreach candidate, $(search_path), $(info $(candidate)))
$(info )
$(info The easiest way to fix this is to set the 'KALEIDOSCOPE_DIR' environment)
$(info variable to the location of your Kaleidoscope directory.)
endif
null-target:
$(info You should never see this message)
@:

View File

@ -53,7 +53,7 @@ enum {
/* QWERTZ+Shift should be MOVED to (and back) still with ability to use SYMBOLS layer from there */ /* QWERTZ+Shift should be MOVED to (and back) still with ability to use SYMBOLS layer from there */
enum { enum {
BASE, // Colemak-DHm: no modifiers BASE, // Colemak-DHm: no modifiers
SHIFT, // Shifted: hold Shift like a sane person // SHIFT, // Shifted: hold Shift like a sane person
SYMBOLS, // SUPER key SYMBOLS, // SUPER key
NAVI, // with FUN or Any key (below , and .) NAVI, // with FUN or Any key (below , and .)
MOUSE, // while holding M key MOUSE, // while holding M key
@ -67,7 +67,8 @@ KEYMAPS(
Key_de_Q ,Key_de_W ,Key_de_F ,Key_de_P ,Key_de_B Key_de_Q ,Key_de_W ,Key_de_F ,Key_de_P ,Key_de_B
,Key_de_A ,Key_de_R ,Key_de_S ,Key_de_T ,Key_de_G ,Key_de_A ,Key_de_R ,Key_de_S ,Key_de_T ,Key_de_G
,Key_de_Y ,Key_de_X ,Key_de_C ,Key_de_D ,Key_de_V ,Key_de_Hash ,Key_de_Y ,Key_de_X ,Key_de_C ,Key_de_D ,Key_de_V ,Key_de_Hash
,Key_de_Tab ,Key_de_Tab ,Key_LeftGui ,MO(SHIFT) ,Key_de_Spacebar ,Key_de_Escape ,Key_de_Tab ,Key_de_Tab ,Key_LeftGui ,Key_de_LeftShift ,Key_de_Spacebar ,Key_de_Escape
// ,Key_de_Tab ,Key_de_Tab ,Key_LeftGui ,MO(SHIFT) ,Key_de_Spacebar ,Key_de_Escape
,Key_de_J ,Key_de_L ,Key_de_U ,Key_de_Z ,Key_de_Semicolon ,Key_de_J ,Key_de_L ,Key_de_U ,Key_de_Z ,Key_de_Semicolon
@ -76,19 +77,19 @@ KEYMAPS(
,Key_de_LeftAlt ,MO(SYMBOLS) ,Key_de_Backspace ,MO(NAVI) ,MO(NAVI) ,Key_Enter ,Key_de_LeftAlt ,MO(SYMBOLS) ,Key_de_Backspace ,MO(NAVI) ,MO(NAVI) ,Key_Enter
), ),
[SHIFT] = KEYMAP_STACKED // [SHIFT] = KEYMAP_STACKED
( // (
LSHIFT(Key_de_Q) ,LSHIFT(Key_de_W) ,LSHIFT(Key_de_F) ,LSHIFT(Key_de_P) ,LSHIFT(Key_de_B) // LSHIFT(Key_de_Q) ,LSHIFT(Key_de_W) ,LSHIFT(Key_de_F) ,LSHIFT(Key_de_P) ,LSHIFT(Key_de_B)
,LSHIFT(Key_de_A) ,LSHIFT(Key_de_R) ,LSHIFT(Key_de_S) ,LSHIFT(Key_de_T) ,LSHIFT(Key_de_G) // ,LSHIFT(Key_de_A) ,LSHIFT(Key_de_R) ,LSHIFT(Key_de_S) ,LSHIFT(Key_de_T) ,LSHIFT(Key_de_G)
,LSHIFT(Key_de_Y) ,LSHIFT(Key_de_X) ,LSHIFT(Key_de_C) ,LSHIFT(Key_de_D) ,LSHIFT(Key_de_V) ,Key_de_LessThan // ,LSHIFT(Key_de_Y) ,LSHIFT(Key_de_X) ,LSHIFT(Key_de_C) ,LSHIFT(Key_de_D) ,LSHIFT(Key_de_V) ,Key_de_LessThan
,LSHIFT(Key_de_Tab) ,LSHIFT(Key_de_Tab) ,___ ,___ ,___ ,___ // ,LSHIFT(Key_de_Tab) ,LSHIFT(Key_de_Tab) ,___ ,___ ,___ ,___
,LSHIFT(Key_de_J) ,LSHIFT(Key_de_L) ,LSHIFT(Key_de_U) ,LSHIFT(Key_de_Z) ,LSHIFT(Key_de_W) // ,LSHIFT(Key_de_J) ,LSHIFT(Key_de_L) ,LSHIFT(Key_de_U) ,LSHIFT(Key_de_Z) ,LSHIFT(Key_de_W)
,LSHIFT(Key_de_M) ,LSHIFT(Key_de_N) ,LSHIFT(Key_de_E) ,LSHIFT(Key_de_I) ,LSHIFT(Key_de_O) // ,LSHIFT(Key_de_M) ,LSHIFT(Key_de_N) ,LSHIFT(Key_de_E) ,LSHIFT(Key_de_I) ,LSHIFT(Key_de_O)
,LSHIFT(Key_de_LessThan) ,LSHIFT(Key_de_K) ,LSHIFT(Key_de_H) ,Key_de_Semicolon ,Key_de_Colon ,Key_de_Backslash // ,LSHIFT(Key_de_LessThan) ,LSHIFT(Key_de_K) ,LSHIFT(Key_de_H) ,Key_de_Semicolon ,Key_de_Colon ,Key_de_Backslash
,___ ,___ ,Key_de_Delete ,___ ,___ ,___ // ,___ ,___ ,Key_de_Delete ,___ ,___ ,___
), // ),
[SYMBOLS] = KEYMAP_STACKED [SYMBOLS] = KEYMAP_STACKED
( (
@ -191,11 +192,11 @@ void setup() {
//umlaute //umlaute
// kaleidoscope::plugin::Qukey(BASE, KeyAddr(1, 2), Key_de_SS), // s -> ß // kaleidoscope::plugin::Qukey(BASE, KeyAddr(1, 2), Key_de_SS), // s -> ß
kaleidoscope::plugin::Qukey(BASE, KeyAddr(1, 0), Key_de_AUml), // a -> ä kaleidoscope::plugin::Qukey(BASE, KeyAddr(1, 0), Key_de_AUml), // a -> ä
kaleidoscope::plugin::Qukey(SHIFT, KeyAddr(1, 0), LSHIFT(Key_de_AUml)), // A -> Ä // kaleidoscope::plugin::Qukey(SHIFT, KeyAddr(1, 0), LSHIFT(Key_de_AUml)), // A -> Ä
kaleidoscope::plugin::Qukey(BASE, KeyAddr(1, 11), Key_de_OUml), // o -> ö kaleidoscope::plugin::Qukey(BASE, KeyAddr(1, 11), Key_de_OUml), // o -> ö
kaleidoscope::plugin::Qukey(SHIFT, KeyAddr(1, 11), LSHIFT(Key_de_OUml)), // o -> Ö // kaleidoscope::plugin::Qukey(SHIFT, KeyAddr(1, 11), LSHIFT(Key_de_OUml)), // o -> Ö
kaleidoscope::plugin::Qukey(BASE, KeyAddr(0, 9), Key_de_UUml), // u -> ü kaleidoscope::plugin::Qukey(BASE, KeyAddr(0, 9), Key_de_UUml), // u -> ü
kaleidoscope::plugin::Qukey(SHIFT, KeyAddr(0, 9), LSHIFT(Key_de_UUml)), // U -> Ü // kaleidoscope::plugin::Qukey(SHIFT, KeyAddr(0, 9), LSHIFT(Key_de_UUml)), // U -> Ü
//common special characters //common special characters
kaleidoscope::plugin::Qukey(BASE, KeyAddr(0, 0), Key_de_At), // q -> @ kaleidoscope::plugin::Qukey(BASE, KeyAddr(0, 0), Key_de_At), // q -> @
@ -207,7 +208,8 @@ void setup() {
kaleidoscope::plugin::Qukey(BASE, KeyAddr(3, 11), Key_de_LeftControl), // bottom right Enter to LCtrl kaleidoscope::plugin::Qukey(BASE, KeyAddr(3, 11), Key_de_LeftControl), // bottom right Enter to LCtrl
kaleidoscope::plugin::Qukey(BASE, KeyAddr(3, 5), Key_LeftGui), // Esc to SUPER kaleidoscope::plugin::Qukey(BASE, KeyAddr(3, 5), Key_LeftGui), // Esc to SUPER
kaleidoscope::plugin::Qukey(BASE, KeyAddr(1, 7), MO(MOUSE)), // M key to mouse layer kaleidoscope::plugin::Qukey(BASE, KeyAddr(1, 7), MO(MOUSE)), // M key to mouse layer
kaleidoscope::plugin::Qukey(BASE, KeyAddr(3, 8), MO(NAVI)), // Backspace to NAVI layer kaleidoscope::plugin::Qukey(BASE, KeyAddr(3, 4), MO(NAVI)), // Space to NAVI layer
// kaleidoscope::plugin::Qukey(BASE, KeyAddr(3, 8), MO(NAVI)), // Backspace to NAVI layer
//hold for "ctrl+" version of the key //hold for "ctrl+" version of the key
kaleidoscope::plugin::Qukey(BASE, KeyAddr(2, 2), LCTRL(Key_de_C)), // c copy kaleidoscope::plugin::Qukey(BASE, KeyAddr(2, 2), LCTRL(Key_de_C)), // c copy
@ -233,6 +235,8 @@ void setup() {
Qukeys.setOverlapThreshold(50); Qukeys.setOverlapThreshold(50);
Kaleidoscope.setup(); Kaleidoscope.setup();
SpaceCadet.disable(); SpaceCadet.disable();
MouseKeys.setSpeedLimit(100);
MouseKeys.setWarpGridSize(MOUSE_WARP_GRID_3X3);
EEPROMKeymap.setup(10); EEPROMKeymap.setup(10);
} }

6
colemak-dhm/sketch.json Normal file
View File

@ -0,0 +1,6 @@
{
"cpu": {
"fqbn": "keyboardio:avr:keyboardio_atreus",
"port": ""
}
}