b2a186cf92
* Purge uGFX. * Remove remnants of visualizer. * Remove remnants of uGFX. |
||
|---|---|---|
| .. | ||
| README.md | ||
| _summary.md | ||
| hardware.md | ||
| hardware_avr.md | ||
| hardware_drivers.md | ||
| hardware_keyboard_guidelines.md | ||
| newbs.md | ||
| newbs_best_practices.md | ||
| newbs_building_firmware.md | ||
| newbs_building_firmware_configurator.md | ||
| newbs_flashing.md | ||
| newbs_getting_started.md | ||
| newbs_learn_more_resources.md | ||
| newbs_testing_debugging.md | ||
README.md
Firmware Quantum Mechanical Keyboard
¿Qué es el firmware QMK?
QMK (Quantum Mechanical Keyboard) es una comunidad open source que mantiene el firmware QMK, QMK Toolbox, qmk.fm, y estos documentos. El firmware QMK es un firmware para teclados basado en tmk_keyboard con algunas características útiles para controladores Atmel AVR, y más específicamente, la línea de productos OLKB, el teclado ErgoDox EZ, y la línea de productos Clueboard. También ha sido portado a chips ARM chips usando ChibiOS. Lo puedes utilizar para manejar tu propio teclado ya sea cableado a mano o basado en una PCB personalizada.
Cómo conseguirlo
Si estás pensando en contribuir con un keymap, teclado, or característica a QMK, la manera más sencilla es hacer un fork del repositorio en GitHub, y clonar tu repositorio localmente para hacer los cambios, subirlos, y abir un Pull Request desde tu fork.
De cualquier manera, también puedes descargarlo directamente en formatos (zip, tar), o clonarlo via git (git@github.com:qmk/qmk_firmware.git), o https (https://github.com/qmk/qmk_firmware.git).
Cómo compilar
Antes de poder compilar, necesitarás instalar un entorno para el desarrollo de AVR y/o ARM. Una vez hayas completado este paso, usarás el comando make para compilar un teclado y keymap con la siguiente notación:
make planck/rev4:default
Este ejemplo compilaría la revisión rev4 del teclado planck con el keymap default. No todos los teclados tienen revisiones (también llamados subproyectos o carpetas), en ese caso, se puede omitir:
make preonic:default
Cómo personalizar
QMK tiene montones de características para explorar, y una buena cantidad de documentación de referencia en la que sumergirse. Se pueden sacar provecho de la mayoría de las características modificando tu keymap, y cambiando los keycodes.