Skip to content

Latest commit

 

History

History
120 lines (85 loc) · 5.34 KB

readme.md

File metadata and controls

120 lines (85 loc) · 5.34 KB

rafaelromao's keyboard layout

Overview

A split keyboard layout optimized for Portuguese, English, working with numbers and software programming with VIM plugins.

img

How this layout works?

The following pages explain how this layout works and which features are implemented.

Layers

Main Features

About this repo

This repository contains the keymap files that are used to customize my keyboards. The firmware files are included as submodules or external references and symlinks are used to make them see the keymap files.

Compatibility

This layout was tested with the keyboards listed below, but can be easily adapted to most ortholinear or column staggered keyboards with at least 30 keys, with 2 of them on each thumb.

QMK

The reference implementation is done in QMK, so it has all features supported.

The qmk version recommended for this keymap is 0.20.1.

Some features are not available on all keyboards though. For instance, the BM40 does not support Dynamic Macros.

ZMK

The zmk version used for this keymap is the one available in this fork, which contains some experimental code from Nick Conway, Cem Aksoylar and Robert U, to implement features like Swapper, Smart Cases and Leader Key, among other small improvements.

Some features might not be available in ZMK. This readme file will indicate what features are available.

Building

QMK

The scripts init_bm40.sh and init_xd75.sh will clone the QMK firmware and symlink these keyboard files on it. After installing QMK and running the init scripts above, qmk cli should be working to compile and flash.

ZMK

The script init_zen.sh will clone the ZMK firmware and configure the toolchain. After installing ZMK and running the init script above, west cli should be working to compile and flash.

References

Most features implemented here were based on the work referenced below.

Layouts

QMK

ZMK

3D Printing and Handwiring

Resouces