qmk_firmware/docs/pt-br

Quantum Mechanical Keyboard Firmware

O que é o firmware QMK?

QMK (Quantum Mechanical Keyboard) é uma comunidade de código aberto que mantém o QMK Firmware, o QMK Toolbox, qmk.fm e suas documentações. O QMK Firmware é um software embarcado ("firmware") de teclado baseado no tmk_keyboard com alguns recursos úteis para os controladores Atmel AVR e, mais especificamente, na linha de produtos OLKB, o teclado ErgoDox EZ e a linha de produtos Clueboard. Também foi portado para chips ARM usando o ChibiOS. Você pode usá-lo no seu próprio teclado com fio ou personalizado.

Como obter e usar o QMK

Se você planeja contribuir com um keymap ("mapa de teclas"), teclado ou recursos para o QMK, o jeito mais fácil é percorrer o repositório através do Github e clonar seu repositório localmente para fazer suas alterações, dê um push nelas e abra uma Pull request no seu fork.

Caso contrário, você pode cloná-lo diretamente com git clone https://github.com/qmk/qmk_firmware. Não faça o download dos arquivos zip ou tar; é necessário um repositório git para baixar os submódulos para compilar.

Como compilar

Antes de compilar, você precisará instalar um ambiente específico para o desenvolvimento em plataforma AVR e/ou ARM; vez que isto for feito, você usará o comando make para criar um teclado e um mapa de teclas com a seguinte notação:

make planck/rev4:default

Isso compilaria a revisão rev4 do teclado planck com o mapa de teclas default. Nem todos os teclados têm revisões (também chamadas de subprojects ou folders); nesse caso, a revisão pode ser omitida:

make preonic:default

Como personalizar

O QMK tem muitos recursos para explorar e uma boa quantidade de documentação de referência para explorar. A maioria dos recursos é aproveitada modificando seu keymap e alterando os keycodes.