Skip to content

Commit

Permalink
first commt
Browse files Browse the repository at this point in the history
  • Loading branch information
Jules Boldewijn committed Mar 12, 2024
0 parents commit 42d37cc
Show file tree
Hide file tree
Showing 16 changed files with 266 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
on: [push, pull_request, workflow_dispatch]

jobs:
build:
uses: zmkfirmware/zmk/.github/workflows/build-user-config.yml@main
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# corne-zmk-5-column

## Chillmin Layout

# Introduction to chillmin Layout


## Layout philosophy

- familiar design for the qwerty alphas
- convinience is priority and minimal by design
- uses only 36 keys


## Base layer and mods

- The CM Layout has 5x3 keys per hand so we can only fit
the main alphabets so we need to use other ZMK features to fit our mod keys.

- We use side two key as combos for the side bar keys

![special_key_combos.png](docs/chillmin/special_key_combos.png)


### Base layer

This is nothing new, only important thing is the modifier keys, enter end space keys.
- Enter keys has layer tap feature, that means holding it will momentarily enble the 1 indexed layer.


![base layer](docs/chillmin/base_col_md.png)

### Number and Symbols Layer

![numsym_layer](docs/chillmin/numsym_md.png)
- Here we have both num pad and num row
- Rest of the symbols with some repeats
- Design for keeps same use case keys closer.

## Fun layer

![fun_layer](docs/chillmin/fun_md.png)

## System layer

![fun_layer](docs/chillmin/sys_md.png)

19 changes: 19 additions & 0 deletions build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# This file generates the GitHub Actions matrix
# For simple board + shield combinations, add them
# to the top level board and shield arrays, for more
# control, add individual board + shield combinations to
# the `include` property, e.g:
#
# board: [ "nice_nano_v2" ]
# shield: [ "corne_left", "corne_right" ]
# include:
# - board: bdn9_rev2
# - board: nice_nano_v2
# shield: reviung41
#
---
include:
- board: nice_nano_v2
shield: corne_left
- board: nice_nano_v2
shield: corne_right
7 changes: 7 additions & 0 deletions config/corne.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Uncomment the following lines to enable the Corne RGB Underglow
# CONFIG_ZMK_RGB_UNDERGLOW=n
# CONFIG_WS2812_STRIP=n

# Uncomment the following line to enable the Corne OLED Display
CONFIG_ZMK_DISPLAY=n
CONFIG_BT_CTLR_TX_PWR_PLUS_8=y
177 changes: 177 additions & 0 deletions config/corne.keymap
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
/*
* Copyright (c) 2020 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/

#include <behaviors.dtsi>
#include <dt-bindings/zmk/bt.h>
#include <dt-bindings/zmk/keys.h>

&mt {
tapping-term-ms = <400>;
quick-tap-ms = <175>;
require-prior-idle-ms = <150>;
flavor = "balanced";
};

&lt { tapping-term-ms = <400>; };

/ {
combos {
compatible = "zmk,combos";

combo_esc {
timeout-ms = <50>;
key-positions = <1 2>;
bindings = <&kp ESCAPE>;
};

combo_bksp {
timeout-ms = <50>;
key-positions = <10 9>;
bindings = <&kp BACKSPACE>;
};

combo_tab {
bindings = <&kp TAB>;
key-positions = <13 14>;
};

combo_shift {
bindings = <&kp LEFT_SHIFT>;
key-positions = <25 26>;
};

combo_delete {
bindings = <&kp DELETE>;
key-positions = <21 22>;
};

combo_rshift {
bindings = <&kp RIGHT_SHIFT>;
key-positions = <33 34>;
};

exclm {
bindings = <&kp EXCLAMATION>;
key-positions = <1 13>;
};

at {
bindings = <&kp AT_SIGN>;
key-positions = <2 14>;
};

hash {
bindings = <&kp HASH>;
key-positions = <3 15>;
};

dllr {
bindings = <&kp DOLLAR>;
key-positions = <4 16>;
};

percnt {
bindings = <&kp PERCENT>;
key-positions = <5 17>;
};

caret {
bindings = <&kp CARET>;
key-positions = <6 18>;
};

and {
bindings = <&kp AMPERSAND>;
key-positions = <7 19>;
};

str {
bindings = <&kp ASTERISK>;
key-positions = <8 20>;
};

leftparen {
bindings = <&kp LPAR>;
key-positions = <9 21>;
};

rparen {
bindings = <&kp RPAR>;
key-positions = <10 22>;
};

layout_switch {
bindings = <&tog 4>;
key-positions = <36 37 40 41>;
};

system_reset {
bindings = <&sys_reset>;
key-positions = <3 4 5>;
};

bootloader {
bindings = <&bootloader>;
key-positions = <15 16 17>;
};

system_layer_combo {
bindings = <&mo 3>;
key-positions = <36 37>;
};
};

conditional_layers { compatible = "zmk,conditional-layers"; };

keymap {
compatible = "zmk,keymap";

colemak_layer {
bindings = <
&none &kp Q &kp W &kp F &kp P &kp B &kp J &kp L &kp U &kp Y &kp SEMICOLON &none
&none &kp A &kp R &kp S &kp T &kp G &kp M &kp N &kp E &kp I &kp O &none
&none &kp Z &kp X &kp C &kp D &kp V &kp K &kp H &kp COMMA &kp DOT &kp FSLH &none
&kp LEFT_CONTROL &kp LEFT_GUI &lt 2 SPACE &lt 1 ENTER &mt RIGHT_SHIFT BACKSPACE &mt LEFT_ALT ESC
>;
};

numsym_layer {
bindings = <
&trans &kp N1 &kp N2 &kp N3 &kp N4 &kp N5 &kp LEFT_BRACKET &kp RIGHT_BRACKET &kp LEFT_BRACE &kp RIGHT_BRACE &trans &trans
&trans &kp NUMBER_6 &kp N7 &kp N8 &kp N9 &kp NUMBER_0 &kp LEFT &kp DOWN &kp UP &kp RIGHT &kp ASTERISK &trans
&trans &kp GRAVE &kp TILDE &kp DQT &kp SQT &kp BSLH &kp LESS_THAN &kp GREATER_THAN &kp MINUS &kp EQUAL &kp SLASH &trans
&trans &trans &trans &trans &trans &trans
>;
};

fun_layer {
bindings = <
&trans &kp F1 &kp F4 &kp F7 &kp F10 &kp C_VOL_UP &kp C_BRIGHTNESS_INC &kp K_PASTE &kp UP_ARROW &kp K_COPY &kp ESC &trans
&trans &kp F2 &kp F5 &kp F8 &kp F11 &kp C_MUTE &kp C_PLAY_PAUSE &kp LEFT_ARROW &kp DOWN_ARROW &kp RIGHT &kp PG_UP &trans
&trans &kp F3 &kp F6 &kp F9 &kp F12 &kp C_VOL_DN &kp C_BRIGHTNESS_DEC &kp K_UNDO &kp K_REDO &kp K_CUT &kp PAGE_DOWN &trans
&trans &trans &trans &trans &trans &trans
>;
};

sys_layer {
bindings = <
&trans &trans &trans &bt BT_PRV &bt BT_NXT &trans &none &trans &trans &trans &trans &trans
&trans &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &bt BT_SEL 4 &trans &none &none &none &none &trans
&trans &bootloader &sys_reset &none &bt BT_CLR &bt BT_CLR_ALL &none &trans &trans &trans &trans &trans
&trans &trans &trans &trans &trans &trans
>;
};

qwerty_layer {
bindings = <
&trans &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &trans
&trans &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &trans
&trans &kp Z &kp X &kp C &kp V &kp B &kp N &kp M &kp COMMA &kp DOT &kp FSLH &trans
&kp LEFT_CONTROL &kp LEFT_GUI &lt 2 SPACE &lt 1 ENTER &mt LEFT_SHIFT BACKSPACE &mt RIGHT_ALT ESC
>;
};
};
};
11 changes: 11 additions & 0 deletions config/west.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
manifest:
remotes:
- name: zmkfirmware
url-base: https://github.com/zmkfirmware
projects:
- name: zmk
remote: zmkfirmware
revision: main
import: app/west.yml
self:
path: config
Binary file added docs/chillmin/base_col_md.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chillmin/base_layer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chillmin/fun_layer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chillmin/fun_md.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chillmin/layer_combos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chillmin/numsym_layer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chillmin/numsym_md.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chillmin/special_key_combos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chillmin/sys_layer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chillmin/sys_md.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 42d37cc

Please sign in to comment.