diff options
Diffstat (limited to 'docs/es')
| -rw-r--r-- | docs/es/README.md | 31 | ||||
| -rw-r--r-- | docs/es/_summary.md | 122 | ||||
| -rw-r--r-- | docs/es/hardware.md | 8 | ||||
| -rw-r--r-- | docs/es/hardware_avr.md | 182 | ||||
| -rw-r--r-- | docs/es/hardware_drivers.md | 31 | ||||
| -rw-r--r-- | docs/es/hardware_keyboard_guidelines.md | 147 | ||||
| -rw-r--r-- | docs/es/newbs.md | 23 | ||||
| -rw-r--r-- | docs/es/newbs_best_practices.md | 159 | ||||
| -rw-r--r-- | docs/es/newbs_building_firmware.md | 81 | ||||
| -rw-r--r-- | docs/es/newbs_building_firmware_configurator.md | 105 | ||||
| -rw-r--r-- | docs/es/newbs_flashing.md | 351 | ||||
| -rw-r--r-- | docs/es/newbs_getting_started.md | 103 | ||||
| -rw-r--r-- | docs/es/newbs_learn_more_resources.md | 15 | ||||
| -rw-r--r-- | docs/es/newbs_testing_debugging.md | 101 |
14 files changed, 0 insertions, 1459 deletions
diff --git a/docs/es/README.md b/docs/es/README.md deleted file mode 100644 index 0d504fad05..0000000000 --- a/docs/es/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Firmware Quantum Mechanical Keyboard - -[](https://github.com/qmk/qmk_firmware/tags) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) - -## ¿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](https://github.com/tmk/tmk_keyboard) con algunas características útiles para controladores Atmel AVR, y más específicamente, la [línea de productos OLKB](https://olkb.com), el teclado [ErgoDox EZ](https://www.ergodox-ez.com), y la [línea de productos Clueboard](https://clueboard.co/). 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](https://github.com/qmk/qmk_firmware#fork-destination-box), y clonar tu repositorio localmente para hacer los cambios, subirlos, y abir un [Pull Request](https://github.com/qmk/qmk_firmware/pulls) desde tu fork. - -De cualquier manera, también puedes descargarlo directamente en formatos ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), 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](es/getting_started_build_tools.md) 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](es/features.md) para explorar, y una buena cantidad de [documentación de referencia](https://docs.qmk.fm) en la que sumergirse. Se pueden sacar provecho de la mayoría de las características modificando tu [keymap](es/keymap.md), y cambiando los [keycodes](es/keycodes.md). diff --git a/docs/es/_summary.md b/docs/es/_summary.md deleted file mode 100644 index aa2a0ca5d9..0000000000 --- a/docs/es/_summary.md +++ /dev/null @@ -1,122 +0,0 @@ -* [Guía completa para novatos](es/newbs.md) - * [Empezando](es/newbs_getting_started.md) - * [Construyendo tu primer firmare](es/newbs_building_firmware.md) - * [Flasheando el firmware](es/newbs_flashing.md) - * [Testeando y depurando ](es/newbs_testing_debugging.md) - * [Mejores práticas](es/newbs_best_practices.md) - * [Recursos de aprendizaje](es/newbs_learn_more_resources.md) - -* [QMK Basics](es/README.md) - * [Introducción a QMK](es/getting_started_introduction.md) - * [QMK CLI](es/cli.md) - * [Configuración de QMK CLI](es/cli_configuration.md) - * [Contribuyendo a QMK](es/contributing.md) - * [Cómo usar GitHub](es/getting_started_github.md) - * [Obtener ayuda](es/getting_started_getting_help.md) - -* [Cambios incompatibles](es/breaking_changes.md) - * [30 Ago 2019](es/ChangeLog/20190830.md) - -* [Preguntas frecuentes](es/faq.md) - * [General](es/faq_general.md) - * [Construir/Compilar QMK](es/faq_build.md) - * [Depurando/Encontrando problemas en QMK](es/faq_debug.md) - * [Keymap](es/faq_keymap.md) - * [Instalación de drivers con Zadig](es/driver_installation_zadig.md) - -* Guías detalladas - * [Instalar herramientas construcción](es/getting_started_build_tools.md) - * [Guía Vagrant](es/getting_started_vagrant.md) - * [Instrucciones de Construcción/Compilado](es/getting_started_make_guide.md) - * [Flasheando Firmware](es/flashing.md) - * [Personalizando funcionalidad](es/custom_quantum_functions.md) - * [Visión general del Keymap](es/keymap.md) - -* [Hardware](es/hardware.md) - * [Procesadores AVR](es/hardware_avr.md) - * [Drivers](es/hardware_drivers.md) - -* Referencia - * [Pautas de teclados](es/hardware_keyboard_guidelines.md) - * [Opciones de configuración](es/config_options.md) - * [Keycodes](es/keycodes.md) - * [Convenciones de código - C](es/coding_conventions_c.md) - * [Convenciones de código - Python](es/coding_conventions_python.md) - * [Mejores prácticas de documentación](es/documentation_best_practices.md) - * [Plantillas de documentación](es/documentation_templates.md) - * [Glosario](es/reference_glossary.md) - * [Tests unitarios](es/unit_testing.md) - * [Funciones útiles](es/ref_functions.md) - * [Sporte configurador](es/reference_configurator_support.md) - * [Formato info.json](es/reference_info_json.md) - * [Desarrollo Python CLI](es/cli_development.md) - -* [Características](es/features.md) - * [Keycodes Básicos](es/keycodes_basic.md) - * [Teclas US ANSI Shifted](es/keycodes_us_ansi_shifted.md) - * [Keycodes Quantum](es/quantum_keycodes.md) - * [Keycodes Avanzados](es/feature_advanced_keycodes.md) - * [Audio](es/feature_audio.md) - * [Auto Shift](es/feature_auto_shift.md) - * [Retroiluminación](es/feature_backlight.md) - * [Bluetooth](es/feature_bluetooth.md) - * [Bootmagic](es/feature_bootmagic.md) - * [Combos](es/feature_combo.md) - * [Comando](es/feature_command.md) - * [API Debounce](es/feature_debounce_type.md) - * [Switch DIP](es/feature_dip_switch.md) - * [Macros Dinámicas](es/feature_dynamic_macros.md) - * [Encoders](es/feature_encoders.md) - * [Grave Escape](es/feature_grave_esc.md) - * [Feedback Háptico](es/feature_haptic_feedback.md) - * [Controlador LCD HD44780](es/feature_hd44780.md) - * [Key Lock](es/feature_key_lock.md) - * [Layouts](es/feature_layouts.md) - * [Tecla Leader](es/feature_leader_key.md) - * [Matriz LED](es/feature_led_matrix.md) - * [Macros](es/feature_macros.md) - * [Teclas del ratón](es/feature_mouse_keys.md) - * [Driver OLED](es/feature_oled_driver.md) - * [Teclas One Shot](es/one_shot_keys.md) - * [Dispositivo de apuntado](es/feature_pointing_device.md) - * [Ratón PS/2](es/feature_ps2_mouse.md) - * [Iluminación RGB](es/feature_rgblight.md) - * [Matriz RGB](es/feature_rgb_matrix.md) - * [Cadete espacial](es/feature_space_cadet.md) - * [Teclado dividido](es/feature_split_keyboard.md) - * [Stenografía](es/feature_stenography.md) - * [Swap Hands](es/feature_swap_hands.md) - * [Tap Dance](es/feature_tap_dance.md) - * [Terminal](es/feature_terminal.md) - * [Impresora Térmica](es/feature_thermal_printer.md) - * [Unicode](es/feature_unicode.md) - * [Userspace](es/feature_userspace.md) - * [Velocikey](es/feature_velocikey.md) - -* Para Makers y Modders - * [Guía de cableado a mano](es/hand_wire.md) - * [Guía de flasheado de ISP](es/isp_flashing_guide.md) - * [Guía de depuración de ARM](es/arm_debugging.md) - * [Driver I2C](es/i2c_driver.md) - * [Driver SPI](es/spi_driver.md) - * [Controles GPIO](es/internals_gpio_control.md) - * [Conversión Proton C](es/proton_c_conversion.md) - -* Para entender en profundidad - * [Cómo funcionan los teclados](es/how_keyboards_work.md) - * [Entendiendo QMK](es/understanding_qmk.md) - -* Otros temas - * [Usando Eclipse con QMK](es/other_eclipse.md) - * [Usando VSCode con QMK](es/other_vscode.md) - * [Soporte](es/getting_started_getting_help.md) - * [Cómo añadir traducciones](es/translating.md) - -* QMK Internals (En progreso) - * [Defines](es/internals_defines.md) - * [Input Callback Reg](es/internals_input_callback_reg.md) - * [Dispositivo Midi](es/internals_midi_device.md) - * [Proceso de configuración de un dispositivo Midi](es/internals_midi_device_setup_process.md) - * [Utilidad Midi](es/internals_midi_util.md) - * [Funciones Send](es/internals_send_functions.md) - * [Herramientas Sysex](es/internals_sysex_tools.md) diff --git a/docs/es/hardware.md b/docs/es/hardware.md deleted file mode 100644 index 085c7e6745..0000000000 --- a/docs/es/hardware.md +++ /dev/null @@ -1,8 +0,0 @@ -# Hardware - -QMK es compatible con una variedad de hardware. Si tu procesador puede ser dirigido por [LUFA](https://www.fourwalledcubicle.com/LUFA.php) o [ChibiOS](https://www.chibios.org), probablemente puedes hacer que QMK se ejecute en él. Esta sección explora cómo hacer que QMK se ejecute y se comunique con hardware de todo tipo. - -* [Pautas de teclados](hardware_keyboard_guidelines.md) -* [Procesadores AVR](hardware_avr.md) -* Procesadores ARM (TBD) -* [Drivers](hardware_drivers.md) diff --git a/docs/es/hardware_avr.md b/docs/es/hardware_avr.md deleted file mode 100644 index ac6a715658..0000000000 --- a/docs/es/hardware_avr.md +++ /dev/null @@ -1,182 +0,0 @@ -# Teclados con Procesadores AVR - -Esta página describe el soporte para procesadores AVR en QMK. Los procesadores AVR incluyen el atmega32u4, atmega32u2, at90usb1286, y otros procesadores de la Corporación Atmel. Los procesadores AVR son MCUs de 8-bit que son diseñados para ser fáciles de trabajar. Los procesadores AVR más comunes en los teclados tienen USB y un montón de GPIO para permitir grandes matrices de teclado. Son los MCUs más populares para el uso en los teclados hoy en día. - -Si aún no lo has hecho, debes leer las [Pautas de teclados](hardware_keyboard_guidelines.md) para tener una idea de cómo los teclados encajan en QMK. - -## Añadir tu Teclado AVR a QMK - -QMK tiene varias características para simplificar el trabajo con teclados AVR. Para la mayoría de los teclados no tienes que escribir ni una sola línea de código. Para empezar, ejecuta `qmk new-keyboard`: - -``` -$ qmk new-keyboard -Ψ Generating a new QMK keyboard directory - -Keyboard Name: mycoolkeeb -Keyboard Type: - 1. avr - 2. ps2avrgb -Please enter your choice: [1] -Your Name: [John Smith] -Ψ Copying base template files... -Ψ Copying avr template files... -Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]... -Ψ Replacing %YEAR% with 2021... -Ψ Replacing %KEYBOARD% with mycoolkeeb... -Ψ Replacing %YOUR_NAME% with John Smith... - -Ψ Created a new keyboard called mycoolkeeb. -Ψ To start working on things, `cd` into keyboards/mycoolkeeb, -Ψ or open the directory in your preferred text editor. -``` - -Esto creará todos los archivos necesarios para tu nuevo teclado, y rellenará la configuración con valores predeterminados. Ahora sólo tienes que personalizarlo para tu teclado. - -## `readme.md` - -Aquí es donde describirás tu teclado. Por favor sigue la [Plantilla del readme de teclados](documentation_templates.md#keyboard-readmemd-template) al escribir tu `readme.md`. Te animamos a colocar una imagen en la parte superior de tu `readme.md`. Por favor, utiliza un servicio externo como [Imgur](https://imgur.com) para alojar las imágenes. - -## `<keyboard>.c` - -Aquí es donde pondrás toda la lógica personalizada para tu teclado. Muchos teclados no necesitan nada aquí. Puedes aprender más sobre cómo escribir lógica personalizada en [Funciones Quantum Personalizadas](custom_quantum_functions.md). - -## `<keyboard>.h` - -Este es el archivo en el que defines tu(s) [Macro(s) de Layout](feature_layouts.md). Por lo menos deberías tener un `#define LAYOUT` para tu teclado que se ve algo así: - -```c -#define LAYOUT( \ - k00, k01, k02, \ - k10, k11 \ -) { \ - { k00, k01, k02 }, \ - { k10, KC_NO, k11 }, \ -} -``` - -La primera mitad de la macro pre-procesador `LAYOUT` define la disposición física de las llaves. La segunda mitad de la macro define la matriz a la que están conectados los interruptores. Esto te permite tener una disposición física de las llaves que difiere de la matriz de cableado. - -Cada una de las variables `k__` tiene que ser única, y normalmente sigue el formato `k<row><col>`. - -La matriz física (la segunda mitad) debe tener un número de filas igualando `MATRIX_ROWS`, y cada fila debe tener exactamente `MATRIX_COLS` elementos. Si no tienes tantas teclas físicas puedes usar `KC_NO` para rellenar los espacios en blanco. - -## `config.h` - -El archivo `config.h` es donde configuras el hardware y el conjunto de características para tu teclado. Hay un montón de opciones que se pueden colocar en ese archivo, demasiadas para listar allí. Para obtener una visión de conjunto completa de las opciones disponibles consulta la página de [Opciones de Configuración](config_options.md). - -### Configuración de hardware - - -En la parte superior de `config.h` encontrarás ajustes relacionados con USB. Estos controlan la apariencia de tu teclado en el Sistema Operativo. Si no tienes una buena razón para cambiar debes dejar el `VENDOR_ID` como `0xFEED`. Para el `PRODUCT_ID` debes seleccionar un número que todavía no esté en uso. - -Cambia las líneas de `MANUFACTURER` y `PRODUCT` para reflejar con precisión tu teclado. - -```c -#define VENDOR_ID 0xFEED -#define PRODUCT_ID 0x6060 -#define DEVICE_VER 0x0001 -#define MANUFACTURER Tú -#define PRODUCT mi_teclado_fantastico -``` - -?> Windows y macOS mostrarán el `MANUFACTURER` y `PRODUCT` en la lista de dispositivos USB. `lsusb` en Linux toma estos de la lista mantenida por el [Repositorio de ID USB](http://www.linux-usb.org/usb-ids.html) por defecto. `lsusb -v` mostrará los valores reportados por el dispositivo, y también están presentes en los registros del núcleo después de conectarlo. - -### Configuración de la matriz del teclado - -La siguiente sección del archivo `config.h` trata de la matriz de tu teclado. Lo primero que debes establecer es el tamaño de la matriz. Esto es generalmente, pero no siempre, el mismo número de filas y columnas como la disposición física de las teclas. - -```c -#define MATRIX_ROWS 2 -#define MATRIX_COLS 3 -``` - -Una vez que hayas definido el tamaño de tu matriz, necesitas definir qué pines en tu MCU están conectados a filas y columnas. Para hacerlo simplemente especifica los nombres de esos pines: - -```c -#define MATRIX_ROW_PINS { D0, D5 } -#define MATRIX_COL_PINS { F1, F0, B0 } -#define UNUSED_PINS -``` - -El número de entradas debe ser el mismo que el número que asignaste a `MATRIX_ROWS`, y del mismo modo para `MATRIX_COL_PINS` y `MATRIX_COLS`. No tienes que especificar `UNUSED_PINS`, pero puedes si deseas documentar qué pines están abiertos. - -Finalmente, puedes especificar la dirección en la que apuntan tus diodos. Esto puede ser `COL2ROW` o `ROW2COL`. - -```c -#define DIODE_DIRECTION COL2ROW -``` - -#### Matriz de patas directas -Para configurar un teclado en el que cada interruptor está conectado a un pin y tierra separados en lugar de compartir los pines de fila y columna, usa `DIRECT_PINS`. La asignación define los pines de cada interruptor en filas y columnas, de izquierda a derecha. Debe ajustarse a los tamaños dentro de `MATRIX_ROWS` y `MATRIX_COLS`. Usa `NO_PIN` para rellenar espacios en blanco. Sobreescribe el comportamiento de `DIODE_DIRECTION`, `MATRIX_ROW_PINS` y `MATRIX_COL_PINS`. - -```c -// #define MATRIX_ROW_PINS { D0, D5 } -// #define MATRIX_COL_PINS { F1, F0, B0 } -#define DIRECT_PINS { \ - { F1, E6, B0, B2, B3 }, \ - { F5, F0, B1, B7, D2 }, \ - { F6, F7, C7, D5, D3 }, \ - { B5, C6, B6, NO_PIN, NO_PIN } \ -} -#define UNUSED_PINS - -/* COL2ROW, ROW2COL */ -//#define DIODE_DIRECTION -``` - -### Configuración de retroiluminación - -QMK soporta retroiluminación en la mayoría de los pines GPIO. Algunos de ellos pueden ser manejados por el MCU en hardware. Para más detalles, consulta la [Documentación de Retroiluminación](feature_backlight.md). - -```c -#define BACKLIGHT_PIN B7 -#define BACKLIGHT_LEVELS 3 -#define BACKLIGHT_BREATHING -#define BREATHING_PERIOD 6 -``` - -### Otras opciones de configuración - -Hay un montón de características que se pueden configurar o ajustar en `config.h`. Debes consultar la página de [Opciones de Configuración](config_options.md) para más detalles. - -## `rules.mk` - -Usa el archivo `rules.mk` para decirle a QMK qué archivos construir y qué características habilitar. Si estás construyendo sobre un atmega32u4 deberías poder dejar mayormente los valores predeterminados. Si estás usando otro MCU es posible que tengas que ajustar algunos parámetros. - -### Opciones MCU - -Estas opciones le indican al sistema de compilación para qué CPU construir. Ten mucho cuidado si cambias cualquiera de estos ajustes. Puedes inutilizar tu teclado. - -```make -MCU = atmega32u4 -F_CPU = 16000000 -ARCH = AVR8 -F_USB = $(F_CPU) -OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT -``` - -### Gestores de arranque - -El gestor de arranque es una sección especial de tu MCU que te permite actualizar el código almacenado en el MCU. Piensa en ello como una partición de rescate para tu teclado. - -#### Ejemplo de gestor de arranque - -```make -BOOTLOADER = halfkay -``` - -#### Ejemplo de cargador DFU Atmel - -```make -BOOTLOADER = atmel-dfu -``` - -#### Ejemplo de gestor de arranque Pro Micro - -```make -BOOTLOADER = caterina -``` - -### Opciones de construcción - -Hay un serie de características que se pueden activar o desactivar en `rules.mk`. Consulta la página de [Opciones de Configuración](config_options.md#feature-options) para obtener una lista detallada y una descripción. diff --git a/docs/es/hardware_drivers.md b/docs/es/hardware_drivers.md deleted file mode 100644 index 788de2c5ef..0000000000 --- a/docs/es/hardware_drivers.md +++ /dev/null @@ -1,31 +0,0 @@ -# Controladores de hardware QMK - -QMK se utiliza en un montón de hardware diferente. Mientras que el soporte para los MCUs y las configuraciones de matriz más comunes está integrado, hay una serie de controladores que se pueden añadir para soportar hardware adicional al teclado. Los ejemplos incluyen ratones y otros dispositivos de apuntamiento, extensores de i/o para teclados divididos, modúlos Bluetooth, y pantallas LCD, OLED y TFT. - -<!-- FIXME: Esto debe hablar de cómo se integran los controladores en QMK y cómo puedes añadir su propio controlador. - -# Descripción del sistema de controladores - ---> - -# Controladores disponibles - -## ProMicro (Solo AVR) - -Soporte para direccionar pines en el ProMicro por su nombre Arduino en lugar de su nombre AVR. Esto necesita ser mejor documentado. Si estás tratando de hacer esto y leer el código no ayuda por favor [abre una issue](https://github.com/qmk/qmk_firmware/issues/new) y podemos ayudarte por el proceso. - -## Controlador OLED SSD1306 - -Soporte para pantallas OLED basadas en SSD1306. Para obtener más información consulta la página de [Característica de Controlador OLED](feature_oled_driver.md). - -## WS2812 (Solo AVR) - -Soporte para LEDs WS2811/WS2812{a,b,c}. Para obtener más información consulta la página de [Luz RGB](feature_rgblight.md). - -## IS31FL3731 - -Soporte para hasta 2 controladores. Cada controlador implementa 2 matrices charlieplex para direccionar LEDs individualmente usando I2C. Esto permite hasta 144 LEDs del mismo color o 32 LEDs RGB. Para obtener más información sobre cómo configurar el controlador, consulta la página de [Matriz RGB](feature_rgb_matrix.md). - -## IS31FL3733 - -Soporte para hasta un solo controlador con espacio para expansión. Cada controlador puede controlar 192 LEDs individuales o 64 LEDs RGB. Para obtener más información sobre cómo configurar el controlador, consulta la página de [Matriz RGB](feature_rgb_matrix.md). diff --git a/docs/es/hardware_keyboard_guidelines.md b/docs/es/hardware_keyboard_guidelines.md deleted file mode 100644 index 298a3b7ce7..0000000000 --- a/docs/es/hardware_keyboard_guidelines.md +++ /dev/null @@ -1,147 +0,0 @@ -# Pautas del teclado QMK - -Desde sus inicios, QMK ha crecido a pasos agigantados gracias a personas como tú que contribuyes a la creación y mantenimiento de nuestros teclados comunitarios. A medida que hemos crecido hemos descubierto algunos patrones que funcionan bien, y pedimos que te ajustes a ellos para que sea más fácil para que otras personas se beneficien de tu duro trabajo. - - -## Nombrar tu Teclado/Proyecto - -Todos los nombres de teclado están en minúsculas, consistiendo sólo de letras, números y guiones bajos (`_`). Los nombres no pueden comenzar con un guión bajo. La barra de desplazamiento (`/`) se utiliza como un carácter de separación de subcarpetas. - -Los nombres `test`, `keyboard`, y `all` están reservados para las órdenes de make y no pueden ser usados como un nombre de teclado o subcarpeta. - -Ejemplos Válidos: - -* `412_64` -* `chimera_ortho` -* `clueboard/66/rev3` -* `planck` -* `v60_type_r` - -## Subcarpetas - -QMK utiliza subcarpetas tanto para organización como para compartir código entre las revisiones del mismo teclado. Puedes anidar carpetas hasta 4 niveles de profundidad: - - qmk_firmware/keyboards/top_folder/sub_1/sub_2/sub_3/sub_4 - -Si una subcarpeta tiene un archivo `rules.mk` será considerado un teclado compilable. Estará disponible en el configurador de QMK y se probará con `make all`. Si estás utilizando una carpeta para organizar varios teclados del mismo fabricante no debes tener un archivo `rules.mk`. - -Ejemplo: - -Clueboard utiliza subcarpetas para ambos propósitos: organización y revisiones de teclado. - -* [`qmk_firmware`](https://github.com/qmk/qmk_firmware/tree/master) - * [`keyboards`](https://github.com/qmk/qmk_firmware/tree/master/keyboards) - * [`clueboard`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard) ← This is the organization folder, there's no `rules.mk` file - * [`60`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/60) ← This is a compilable keyboard, it has a `rules.mk` file - * [`66`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66) ← This is also compilable- it uses `DEFAULT_FOLDER` to specify `rev3` as the default revision - * [`rev1`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev1) ← compilable: `make clueboard/66/rev1` - * [`rev2`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev2) ← compilable: `make clueboard/66/rev2` - * [`rev3`](https://github.com/qmk/qmk_firmware/tree/master/keyboards/clueboard/66/rev3) ← compilable: `make clueboard/66/rev3` or `make clueboard/66` - -## Estructura de carpetas de teclado - -Su teclado debe estar ubicado en `qmk_firm cuidada/keyboards/` y el nombre de la carpeta debe ser el nombre de su teclado como se describe en la sección anterior. Dentro de esta carpeta debe haber varios archivos: - -* `readme.md` -* `info.json` -* `config.h` -* `rules.mk` -* `<keyboard_name>.c` -* `<keyboard_name>.h` - -### `readme.md` - -Todos los proyectos necesitan tener un archivo `readme.md` que explica lo que es el teclado, quién lo hizo y dónde está disponible. Si es aplicable, también debe contener enlaces a más información, como el sitio web del fabricante. Por favor, sigue la [plantilla publicada](documentation_templates.md#keyboard-readmemd-template). - -### `info.json` - -Este archivo es utilizado por la [API de QMK](https://github.com/qmk/qmk_api). Contiene la información que [configurador de QMK](https://config.qmk.fm/) necesita mostrar en una representación de su teclado. También puede establecer metadatos aquí. Para más información, consulta la [página de referencia](reference_info_json.md). - -### `config.h` - -Todos los proyectos necesitan tener un archivo `config.h` que establece cosas como el tamaño de la matriz, nombre del producto, USB VID/PID, descripción y otros ajustes. En general, usa este archivo para establecer la información esencial y los valores predeterminados para tu teclado que siempre funcionarán. - -### `rules.mk` - -La presencia de este archivo indica que la carpeta es un destino de teclado y se puede utilizar en las órdenes `make`. Aquí es donde estableces el entorno de compilación para tu teclado y configuras el conjunto predeterminado de características. - -### `<keyboard_name.c>` - -Aquí es donde escribirás código personalizado para tu teclado. Típicamente escribirás código para inicializar e interactuar con el hardware de tu teclado. Si tu teclado se compone de sólo una matriz de teclas sin LEDs, altavoces u otro hardware auxiliar este archivo puede estar en blanco. - -Las funciones siguientes se definen típicamente en este archivo: - -* `void matrix_init_kb(void)` -* `void matrix_scan_kb(void)` -* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` -* `void led_set_kb(uint8_t usb_led)` - -### `<keyboard_name.h>` - -Este archivo se utiliza para definir la matriz para tu teclado. Debes definir al menos un macro de C que traduce una serie en una matriz que representa la matriz de interruptor físico para tu teclado. Si es posible construir tu teclado con múltiples diseños debes definir macros adicionales. - -Si solo tienes un diseño debes llamar a esta macro `LAYOUT`. - -Al definir diseños múltiples debes tener un diseño base, llamado `LAYOUT_all`, que soporte todas las posibles posiciones de switch en tu matriz, incluso si ese diseño es imposible de construir físicamente. Esta es la macro que deberías usar en tu keymap `predeterminado`. Debes tener keymaps adicionales llamados `default_ término layout>` que usen tus otras macros de diseño. Esto hará que sea más fácil para las personas utilizar los diseños que defines. - -Los nombres de las macros de diseño son completamente minúsculas, excepto por la palabra `LAYOUT` en el frente. - -Por ejemplo, si tienes un PCB de 60% que soporta ANSI e ISO podría definir los siguientes diseños y keymaps: - -| Nombre de diseño | Nombre de keymap | Descripción | -|-------------|-------------|-------------| -| LAYOUT_all | default | Un diseño que soporta tanto ISO como ANSI | -| LAYOUT_ansi | default_ansi | Un diseño ANSI | -| LAYOUT_iso | default_iso | Un diseño ISO | - -## Archivos de Imagen/Hardware - -En un esfuerzo por mantener el tamaño de repo abajo ya no estamos aceptando archivos binarios de cualquier formato, con pocas excepciones. Alojarlos en otro lugar (por ejemplo <https://imgur.com>) y enlazarlos en el `readme.md` es preferible. - -Para archivos de hardware (tales como placas, casos, pcb) puedes contribuir a [qmk.fm repo](https://github.com/qmk/qmk.fm) y estarán disponibles en [qmk.fm](https://qmk.fm). Archivos descargables se almacenan en `/<teclado>/` (nombre sigue el mismo formato que el anterior), se sirven en `https://qmk.fm/<teclado>/`, y se generan páginas de `/_pages/<teclado>/` que se sirven en la misma ubicación (Los archivos .md se generan en archivos .html mediante Jekyll). Echa un vistazo a la carpeta `lets_split` para ver un ejemplo. - -## Predeterminados de teclado - -Dada la cantidad de funcionalidad que expone QMK, es muy fácil confundir a los nuevos usuarios. Al armar el firmware predeterminado para tu teclado, te recomendamos limitar tus funciones y opciones habilitadas al conjunto mínimo necesario para soportar tu hardware. A continuación se formulan recomendaciones sobre características específicas. - -### Bootmagic y Command - -[Bootmagic](feature_bootmagic.md) and [Command](feature_command.md) son dos características relacionadas que permiten a un usuario controlar su teclado de manera no obvia. Te recomendamos que piense largo y tendido acerca de si vas a habilitar cualquiera de las características, y cómo vas a exponer esta funcionalidad. Tengas en cuenta que los usuarios que quieren esta funcionalidad puede habilitarla en sus keymaps personales sin afectar a todos los usuarios novatos que pueden estar usando tu teclado como su primera tarjeta programable. - -De lejos el problema más común con el que se encuentran los nuevos usuarios es la activación accidental de Bootmagic mientras están conectando su teclado. Están sosteniendo el teclado por la parte inferior, presionando sin saberlo en alt y barra espaciadora, y luego se dan cuenta de que estas teclas han sido intercambiadas en ellos. Recomendamos dejar esta característica deshabilitada de forma predeterminada, pero si la activas consideres establecer la opción `BOOTMAGIC_KEY_SALT` a una tecla que es difícil de presionar al conectar el teclado. - -Si tu teclado no tiene 2 teclas de cambio debes proporcionar un predeterminado de trabajo para `IS_COMMAND`, incluso cuando haya definido `COMMAND_ENABLE = no`. Esto dará a sus usuarios un valor predeterminado para ajustarse a si lo hacen enable Command. - -## Programación de teclado personalizado - -Como se documenta en [Funcionalidad de Adaptación](custom_quantum_functions.md) puedes definir funciones personalizadas para tu teclado. Por favor, tengas en cuenta que sus usuarios pueden querer personalizar ese comportamiento así, y hacer que sea posible para que puedan hacer eso. Si está proporcionando una función personalizada, por ejemplo `process_record_kb()`, asegúrese de que su función también llame a la versión` `_user()` de la llamada. También debes tener en cuenta el valor de retorno de la versión `_user()`, y ejecutar sólo tu código personalizado si el usuario devuelve `true`. - -## Proyectos Sin Producción/Conectados A Mano - -Estamos encantados de aceptar cualquier proyecto que utilice QMK, incluidos los prototipos y los cableados de mano, pero tenemos una carpeta `/keyboards/handwired/` separada para ellos, por lo que la carpeta `/keyboards/` principal no se llena. Si un proyecto prototipo se convierte en un proyecto de producción en algún momento en el futuro, ¡estaremos encantados de moverlo a la carpeta `/keyboards/` principal! - -## Advertencias como errores - -Al desarrollar su teclado, tengas en cuenta que todas las advertencias serán tratadas como errores - estas pequeñas advertencias pueden acumularse y causar errores más grandes en el camino (y pierdan es generalmente una mala práctica). - -## Derechos de autor - -Si estás adaptando la configuración de tu teclado de otro proyecto, pero no utilizando el mismo código, asegúrese de actualizar la cabecera de derechos de autor en la parte superior de los archivos para mostrar tu nombre, en este formato: - - Copyright 2017 Tu nombre <tu@email.com> - -Si estás modificando el código de otra persona y sólo ha hecho cambios triviales debes dejar su nombre en la declaración de derechos de autor. Si has hecho un trabajo significativo en el archivo debe agregar tu nombre a la de ellos, así: - - Copyright 2017 Su nombre <original_author@ejemplo.com> Tu nombre <tu@ejemplo.com> - -El año debe ser el primer año en que se crea el archivo. Si el trabajo se hizo a ese archivo en años posteriores puedes reflejar que mediante la adición del segundo año a la primera, como así: - - Copyright 2015-2017 Tu nombre <tu@ejemplo.com> - -## Licencia - -El núcleo de QMC está licenciado bajo la [GNU General Public License](https://www.gnu.org/licenses/licenses.en.html). Si estás enviando binarios para los procesadores AVR puedes elegir cualquiera [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html) o [GPLv3](https://www.gnu.org/licenses/gpl.html). Si estás enviando binarios para ARM procesadores debes elegir [GPL Versión 3](https://www.gnu.org/licenses/gpl.html) para cumplir con los [ChibiOS](https://www.chibios.org) licencia GPLv3. - -## Detalles técnicos - -Si estás buscando más información sobre cómo hacer que su teclado funcione con QMK, [echa un vistazo a la sección hardware](hardware.md)! diff --git a/docs/es/newbs.md b/docs/es/newbs.md deleted file mode 100644 index 7e08b679c3..0000000000 --- a/docs/es/newbs.md +++ /dev/null @@ -1,23 +0,0 @@ -# La guía completa de QMK para novatos - -QMK es un poderoso firmware Open Source para tu teclado mecánico. Puedes utilizar QMK para personalizar tu teclado en maneras a la vez simples y potentes. Gente de todos los niveles de habilidad, desde completos novatos hasta expertos programadores, han utilizado con éxito QMK para personalizar sus teclados. Esta guía te ayudará a hacer lo mismo, sin importar tu nivel de habilidad. - -¿No estás seguro de si tu teclado puede ejecutar QMK? Si es un teclado mecánico construido por ti mismo probablemente puedas. Damos soporte a [gran número de placas de hobbistas](https://qmk.fm/keyboards/), e incluso si tu teclado actual no pudiera ejecutar QMK no deberías tener problemas encontrando uno que cumpliera tus necesidades. - -## Visión general - -Hay 7 secciones principales en esta guía: - -* [Empezando](newbs_getting_started.md) -* [Construyendo tu primer firmware](newbs_building_firmware.md) -* [Construyendo tu primer firmware usando la GUI](newbs_building_firmware_configurator.md) -* [Flasheando el firmware](newbs_flashing.md) -* [Testeando y depurando](newbs_testing_debugging.md) -* [Mejores práticas](newbs_best_practices.md) -* [Recursos de aprendizaje](newbs_learn_more_resources.md) - -Esta guía está enfocada en ayudar a alguien que nunca ha compilado software con anterioridad. Toma decisiones y hace recomendaciones teniendo en cuenta este punto de vista. Hay métodos alternativos para muchos de estos procedimientos, y soportamos la mayoría de esas alternativas. Si tienes alguna duda sobre cómo llevar a cabo una tarea nos puedes [preguntar para que te guiemos](getting_started_getting_help.md). - -## Recursos adicionales - -* [Blog de Básicos de Thomas Baart's QMK](https://thomasbaart.nl/category/mechanical-keyboards/firmware/qmk/qmk-basics/) – Un blog creado por un usuario que cubre lo básico sobre cómo usar el firmware QMK Firmware, visto desde la perspectiva de un usuario nuevo. diff --git a/docs/es/newbs_best_practices.md b/docs/es/newbs_best_practices.md deleted file mode 100644 index 2f72eff788..0000000000 --- a/docs/es/newbs_best_practices.md +++ /dev/null @@ -1,159 +0,0 @@ -# Mejores prácticas - -## O, "Cómo aprendí a dejar de preocuparme y amarle a Git." - -Este documento procura instruir a los novatos en las mejores prácticas para tener una experiencia más fácil en contribuir a QMK. Te guiaremos por el proceso de contribuir a QMK, explicando algunas maneras de hacerlo más fácilmente, y luego romperemos algunas cosas para enseñarte cómo arreglarlas. - -En este documento suponemos un par de cosas: - -1. Tienes una cuenta de GitHub, y has hecho un [fork del repo qmk_firmware](getting_started_github.md) en tu cuenta. -2. Has [configurado tu entorno de desarrollo](newbs_getting_started.md?id=environment-setup). - - -## La rama master de tu fork: Actualizar a menudo, nunca commit - -Se recomienda que para desarrollo con QMK, lo que sea que estés haciendo, mantener tu rama `master` actualizada, pero **nunca** commit en ella. Mejor, haz todos tus cambios en una rama de desarrollo y manda pull requests de tus ramas mientras programas. - -Para evitar los conflictos de merge — cuando dos o más usuarios han editado la misma parte de un archivo al mismo tiempo — mantén tu rama `master` actualizada, y empieza desarrollo nuevo creando una nueva rama. - -### Actualizando tu rama master - -Para mantener tu rama `master` actualizada, se recomienda agregar el repository ("repo") de Firmware QMK como un repo remoto en git. Para hacer esto, abre tu interfaz de línea de mandatos y ingresa: -``` -git remote add upstream https://github.com/qmk/qmk_firmware.git -``` - -Para verificar que el repo ha sido agregado, ejecuta `git remote -v`, y lo siguiente debe aparecer: - -``` -$ git remote -v -origin https://github.com/<your_username>/qmk_firmware.git (fetch) -origin https://github.com/<your_username>/qmk_firmware.git (push) -upstream https://github.com/qmk/qmk_firmware.git (fetch) -upstream https://github.com/qmk/qmk_firmware.git (push) -``` - -Ya que has hecho esto, puedes buscar actualizaciones del repo ejecutando `git fetch upstream`. Esto busca las ramas y etiquetas — juntos conocidos como "refs" — del repo QMK, que ahora tiene el apodo `upstream`. Ahora podemos comparar los archivos en nuestro fork `origin` con los de QMK. - -Para actualizar la rama master de tu fork, ejecuta lo siguiente, pulsando Intro después de cada línea: - -``` -git checkout master -git fetch upstream -git pull upstream master -git push origin master -``` - -Esto te coloca en tu rama master, busca los refs del repo de QMK, descarga la rama `master` actual a tu computadora, y después lo sube a tu fork. - -### Hacer cambios - -Para hacer cambios, crea una nueva rama ejecutando: - -``` -git checkout -b dev_branch -git push --set-upstream origin dev_branch -``` - -Esto crea una nueva rama llamada `dev_branch`, te coloca en ella, y después guarda la nueva rama a tu fork. El parámetro `--set-upstream` le dice a git que use tu fork y la rama `dev_branch` cada vez que uses `git push` o `git pull` en esta rama. Solo necesitas usarlo la primera que que subes cambios; ya después, puedes usar `git push` o `git pull`, sin usar los demás parámetros. - -!> Con `git push`, puedes usar `-u` en vez de `--set-upstream` — `-u` es un alias de `--set-upstream`. - -Puedes nombrar tu rama casi cualquier cosa, pero se recomienda ponerle algo con relación a los cambios que vas a hacer. - -Por defecto `git checkout -b` se basará tu nueva rama en la rama en la cual estás actualmente. Puedes basar tu rama en otra rama existente agregando el nombre de la rama al comando: - -``` -git checkout -b dev_branch master -``` - -Ahora que tienes una rama development, abre tu editor de texto y haz los cambios que quieres. Se recomienda hacer varios commits pequeños a tu rama; de este modo cualquier cambio que causa problemas puede ser rastreado y deshecho si fuera necesario. Para hacer tus ca |