giovanebribeiro / keymaps

My keymaps for mechanical keyboards (powered by QMK)

keymaps

Meus layouts de teclado mecanico (utilizando o firmware QMK). Baseado neste projeto incrível.

** Layout planck: http://www.keyboard-layout-editor.com/#/gists/007758183ad549d0f8c639c4e0617ce2 **

Organização

Este projeto está estruturado da seguinte forma:

.
|____README.md          # Você está aqui
|____Makefile           # Arquivo para automações de build
|____LICENSE            # Arquivo da licença
|____user               # Pasta com as customizações no layout original (definições de layers, macros, etc)
| |____my.h             # Biblioteca de definições customizada
|____planck             # Layout para o teclado planck
| |____config.h 
| |____keymap.c 
| |____readme.md 
| |____rules.mk
|____qmk_firmware       # Firmware QMK (Adicionado como um submódulo git)

Procedimentos iniciais

Antes de começar tudo, você precisa instalar algumas ferramentas. Depois, basta executar o comando make setup:

ARM GNU Toolchain

Inicialmente, baixe o tarball correspondente (x86_64) neste link

Em seguida, instale a aplicação:

$ sudo tar xf arm-gnu-toolchain-YOUR_VERSION-x86_64-arm-none-eabi.tar.xz -C /usr/share/
$ sudo ln -s /usr/share/arm-gnu-toolchain-YOUR_VERSION-x86_64-arm-none-eabi/bin/arm-none-eabi-gcc /usr/bin/arm-none-eabi-gcc
$ sudo ln -s /usr/share/arm-gnu-toolchain-YOUR_VERSION-x86_64-arm-none-eabi/bin/arm-none-eabi-g++ /usr/bin/arm-none-eabi-g++
$ sudo ln -s /usr/share/arm-gnu-toolchain-YOUR_VERSION-x86_64-arm-none-eabi/bin/arm-none-eabi-gdb /usr/bin/arm-none-eabi-gdb
$ sudo ln -s /usr/share/arm-gnu-toolchain-YOUR_VERSION-x86_64-arm-none-eabi/bin/arm-none-eabi-size /usr/bin/arm-none-eabi-size
$ sudo ln -s /usr/share/arm-gnu-toolchain-YOUR_VERSION-x86_64-arm-none-eabi/bin/arm-none-eabi-objcopy /usr/bin/arm-none-eabi-objcopy

Em seguida, testamos para saber se está tudo ok. Caso falte alguma dependência, deve ser instalada manualmente. Infelizmente, não há como saber quais dependências estão faltando pois depende muito do seu sistema. Como exemplo, temos a instalação da dependência libncurses.so.5:

$ sudo apt install libncurses-dev
$ sudo ln -s /usr/lib/x86_64-linux-gnu/libncurses.so.6 /usr/lib/x86_64-linux-gnu/libncurses.so.5
$ sudo ln -s /usr/lib/x86_64-linux-gnu/libtinfo.so.6 /usr/lib/x86_64-linux-gnu/libtinfo.so.5

# Testando tudo:

$ arm-none-eabi-gcc --version
$ arm-none-eabi-g++ --version
$ arm-none-eabi-gdb --version
$ arm-none-eabi-size --version

Como utilizar

A maioria dos procedimentos foram automatizados por meio de um makefile. Para listar todos os procedimentos disponíveis, basta executar o comando make

o client do QMK não está incluso com este projeto. Você precisa baixá-lo seguindo as instruções deste link.