1
0
Fork 0

Update readme

This commit is contained in:
Danny Nguyen 2017-05-30 13:23:09 -04:00
parent 4a8da0cb45
commit be204f9cdd
5 changed files with 93 additions and 61 deletions

View file

@ -1,4 +1,4 @@
Hexwire's Let's Split Layout
Hexwire's Nyquist Layout
============================
### Changes from default layout
@ -23,73 +23,79 @@ Hexwire's Let's Split Layout
## Layouts
### Qwerty
### QWERTY
```
,----+----+----+----+----+----. ,----+----+----+----+----+----.
TAB , Q , W , E , R , T , Y , U , I , O , P ,MINS,
|ESC , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 ,BSPC|
|----+----+----+----+----+----| |----+----+----+----+----+----|
X0 , A , S , D , F , G , H , J , K , L ,SCLN,QUOT,
|TAB , Q , W , E , R , T , Y , U , I , O , P ,MINS|
|----+----+----+----+----+----| |----+----+----+----+----+----|
LSFT, Z , X , C , V , B , N , M ,COMM,DOT ,SLSH, X4 ,
| X0 , A , S , D , F , G , H , J , K , L ,SCLN,QUOT|
|----+----+----+----+----+----| |----+----+----+----+----+----|
X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT
|LSFT, Z , X , C , V , B , N , M ,COMM,DOT ,SLSH, X4 |
|----+----+----+----+----+----| |----+----+----+----+----+----|
| X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT|
`----+----+----+----+----+----' `----+----+----+----+----+----'
```
### Colemak
```
,----+----+----+----+----+----. ,----+----+----+----+----+----.
TAB , Q , W , F , P , G , J , L , U , Y ,SCLN,MINS,
|ESC , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 ,BSPC|
|----+----+----+----+----+----| |----+----+----+----+----+----|
X0 , A , R , S , T , D , H , N , E , I , O ,QUOT,
|TAB , Q , W , F , P , G , J , L , U , Y ,SCLN,MINS|
|----+----+----+----+----+----| |----+----+----+----+----+----|
LSFT, Z , X , C , V , B , K , M ,COMM,DOT ,SLSH, X4 ,
| X0 , A , R , S , T , D , H , N , E , I , O ,QUOT|
|----+----+----+----+----+----| |----+----+----+----+----+----|
X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT
|LSFT, Z , X , C , V , B , K , M ,COMM,DOT ,SLSH, X4 |
|----+----+----+----+----+----| |----+----+----+----+----+----|
| X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT|
`----+----+----+----+----+----' `----+----+----+----+----+----'
```
### Dvorak
```
,----+----+----+----+----+----. ,----+----+----+----+----+----.
TAB ,QUOT,COMM,DOT , P , Y , F , G , C , R , L ,MINS,
|ESC , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 ,BSPC|
|----+----+----+----+----+----| |----+----+----+----+----+----|
X0 , A , O , E , U , I , D , H , R , N , S ,SLSH,
|TAB ,QUOT,COMM,DOT , P , Y , F , G , C , R , L ,MINS|
|----+----+----+----+----+----| |----+----+----+----+----+----|
LSFT,SCLN, Q , J , K , X , B , M , W , V , Z , X4 ,
| X0 , A , O , E , U , I , D , H , R , N , S ,SLSH|
|----+----+----+----+----+----| |----+----+----+----+----+----|
X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT
|LSFT,SCLN, Q , J , K , X , B , M , W , V , Z , X4 |
|----+----+----+----+----+----| |----+----+----+----+----+----|
| X3 ,LCTL,LALT,LGUI, X1 ,SPC , BSPC, X2 ,LEFT,DOWN, UP ,RGHT|
`----+----+----+----+----+----' `----+----+----+----+----+----'
```
### Lower
```
,----+----+----+----+----+----. ,----+----+----+----+----+----.
, 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 , ,
|TILD,EXLM, AT ,HASH,DLR ,PERC, CIRC,AMPR,ASTR,LPRN,RPRN,BSPC|
|----+----+----+----+----+----| |----+----+----+----+----+----|
DEL ,CAPP,LEFT,RGHT, UP ,LBRC, RBRC, P4 , P5 , P6 ,PLUS,PIPE,
| , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 , |
|----+----+----+----+----+----| |----+----+----+----+----+----|
,CPYP, , ,DOWN,LCBR, RCBR, P1 , P2 , P3 ,MINS, ,
|DEL ,CAPP,LEFT,RGHT, UP ,LBRC, RBRC, P4 , P5 , P6 ,PLUS,PIPE|
|----+----+----+----+----+----| |----+----+----+----+----+----|
, , , , , , DEL , , P0 ,PDOT, ,
| ,CPYP, , ,DOWN,LCBR, RCBR, P1 , P2 , P3 ,MINS, |
|----+----+----+----+----+----| |----+----+----+----+----+----|
| , , , , , , DEL , , P0 ,PDOT, , |
`----+----+----+----+----+----' `----+----+----+----+----+----'
```
### Raise
```
,----+----+----+----+----+----. ,----+----+----+----+----+----.
,EXLM, AT ,HASH,DLR ,PERC, CIRC,AMPR,ASTR,LPRN,RPRN, ,
|TILD,EXLM, AT ,HASH,DLR ,PERC, CIRC,AMPR,ASTR,LPRN,RPRN,BSPC|
|----+----+----+----+----+----| |----+----+----+----+----+----|
DEL ,MPRV,MNXT,VOLU,PGUP,UNDS, EQL ,HOME, , , ,BSLS,
| ,EXLM, AT ,HASH,DLR ,PERC, CIRC,AMPR,ASTR,LPRN,RPRN, |
|----+----+----+----+----+----| |----+----+----+----+----+----|
MUTE,MSTP,MPLY,VOLD,PGDN,MINS, PLUS,END , , , , ,
|DEL ,MPRV,MNXT,VOLU,PGUP,UNDS, EQL ,HOME, , , ,BSLS|
|----+----+----+----+----+----| |----+----+----+----+----+----|
, , , , , , , , , , ,
|MUTE,MSTP,MPLY,VOLD,PGDN,MINS, PLUS,END , , , , |
|----+----+----+----+----+----| |----+----+----+----+----+----|
| , , , , , , , , , , , |
`----+----+----+----+----+----' `----+----+----+----+----+----'
```
@ -97,12 +103,14 @@ Hexwire's Let's Split Layout
```
,----+----+----+----+----+----. ,----+----+----+----+----+----.
F12 , F1 , F2 , F3 , F4 , F5 , F6 , F7 , F8 , F9 ,F10 ,F11 ,
|F12 , F1 , F2 , F3 , F4 , F5 , F6 , F7 , F8 , F9 ,F10 ,F11 |
|----+----+----+----+----+----| |----+----+----+----+----+----|
, , , , , , , , , , , ,
| , , , , , , , , , , , |
|----+----+----+----+----+----| |----+----+----+----+----+----|
, , , , , , , , , , , ,
| , , , , , , , , , , , |
|----+----+----+----+----+----| |----+----+----+----+----+----|
, , , , , , , , , , ,
| , , , , , , , , , , , |
|----+----+----+----+----+----| |----+----+----+----+----+----|
| , , , , , , , , , , , |
`----+----+----+----+----+----' `----+----+----+----+----+----'
```

View file

@ -119,7 +119,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
//|----+----+----+----+----+----| |----+----+----+----+----+----|
, , , , , , , , , , , ,
//|----+----+----+----+----+----| |----+----+----+----+----+----|
, , , , , , , , , , ,
, , , , , , , , , , ,
//`----+----+----+----+----+----' `----+----+----+----+----+----'
),

View file

@ -0,0 +1,39 @@
#!/usr/bin/env python
import re
class KeymapConverter:
def __init__(self, filename):
self.filename = filename
def read_keymaps(self):
with open(self.filename) as f:
lines = f.readlines()
mode = 0
for line in lines:
line = line[:-1]
if mode == 0:
if "KC_KEYMAP" in line:
matches = re.match(r'.*\[(.*)\] = .*', line)
if matches:
layer_name = matches.group(1)
layer_name = layer_name[1:].capitalize()
print '###', layer_name
print '```'
mode = 1
elif mode == 1:
if "//" in line:
print line[4:]
elif ")" in line:
mode = 0
print '```'
print
elif line[-1] == ',':
print "|" + line[5:-1] + "|"
else:
print "|" + line[5:] + "|"
converter = KeymapConverter('keymap.c')
converter.read_keymaps()

View file

@ -15,7 +15,7 @@ class KeymapConverter
def parse_line(line)
case @mode
when :search
if line =~ /COMPACT_KEYMAP/
if line =~ /KC_KEYMAP/
puts "### #{line}"
puts "```"
@mode = :parse