diff options
author | Ryan <fauxpark@gmail.com> | 2020-07-16 15:49:18 +1000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-07-16 15:49:18 +1000 |
commit | 72d327054744fa142469dbb5406ad61f5ad0a302 (patch) | |
tree | bbdf7937d6837ffdd323391f3dde2e9538fa447e /docs | |
parent | 92d0a71af71973ac3f80398ed4f7f61dd97733b3 (diff) | |
download | qmk_firmware-72d327054744fa142469dbb5406ad61f5ad0a302.tar.gz qmk_firmware-72d327054744fa142469dbb5406ad61f5ad0a302.zip |
Remove `DESCRIPTION` (#9732)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/config_options.md | 2 | ||||
-rw-r--r-- | docs/es/hardware_avr.md | 3 | ||||
-rw-r--r-- | docs/hardware_avr.md | 3 | ||||
-rw-r--r-- | docs/ja/config_options.md | 2 | ||||
-rw-r--r-- | docs/ja/hardware_avr.md | 3 |
5 files changed, 3 insertions, 10 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index 21c9972e0..81a3b4b61 100644 --- a/docs/config_options.md +++ b/docs/config_options.md | |||
@@ -43,8 +43,6 @@ This is a C header file that is one of the first things included, and will persi | |||
43 | * generally who/whatever brand produced the board | 43 | * generally who/whatever brand produced the board |
44 | * `#define PRODUCT Board` | 44 | * `#define PRODUCT Board` |
45 | * the name of the keyboard | 45 | * the name of the keyboard |
46 | * `#define DESCRIPTION a keyboard` | ||
47 | * a short description of what the keyboard is | ||
48 | * `#define MATRIX_ROWS 5` | 46 | * `#define MATRIX_ROWS 5` |
49 | * the number of rows in your keyboard's matrix | 47 | * the number of rows in your keyboard's matrix |
50 | * `#define MATRIX_COLS 15` | 48 | * `#define MATRIX_COLS 15` |
diff --git a/docs/es/hardware_avr.md b/docs/es/hardware_avr.md index 4236292a1..2ecf78d66 100644 --- a/docs/es/hardware_avr.md +++ b/docs/es/hardware_avr.md | |||
@@ -67,7 +67,7 @@ El archivo `config.h` es donde configuras el hardware y el conjunto de caracterà | |||
67 | 67 | ||
68 | 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. | 68 | 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. |
69 | 69 | ||
70 | Cambia las lÃneas de `MANUFACTURER`, `PRODUCT`, y `DESCRIPTION` para reflejar con precisión tu teclado. | 70 | Cambia las lÃneas de `MANUFACTURER` y `PRODUCT` para reflejar con precisión tu teclado. |
71 | 71 | ||
72 | ```c | 72 | ```c |
73 | #define VENDOR_ID 0xFEED | 73 | #define VENDOR_ID 0xFEED |
@@ -75,7 +75,6 @@ Cambia las lÃneas de `MANUFACTURER`, `PRODUCT`, y `DESCRIPTION` para reflejar c | |||
75 | #define DEVICE_VER 0x0001 | 75 | #define DEVICE_VER 0x0001 |
76 | #define MANUFACTURER Tú | 76 | #define MANUFACTURER Tú |
77 | #define PRODUCT mi_teclado_fantastico | 77 | #define PRODUCT mi_teclado_fantastico |
78 | #define DESCRIPTION Un teclado personalizado | ||
79 | ``` | 78 | ``` |
80 | 79 | ||
81 | ?> 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. | 80 | ?> 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. |
diff --git a/docs/hardware_avr.md b/docs/hardware_avr.md index 697c55d2a..2c0f2e9a1 100644 --- a/docs/hardware_avr.md +++ b/docs/hardware_avr.md | |||
@@ -67,7 +67,7 @@ The `config.h` file is where you configure the hardware and feature set for your | |||
67 | 67 | ||
68 | At the top of the `config.h` you'll find USB related settings. These control how your keyboard appears to the Operating System. If you don't have a good reason to change you should leave the `VENDOR_ID` as `0xFEED`. For the `PRODUCT_ID` you should pick a number that is not yet in use. | 68 | At the top of the `config.h` you'll find USB related settings. These control how your keyboard appears to the Operating System. If you don't have a good reason to change you should leave the `VENDOR_ID` as `0xFEED`. For the `PRODUCT_ID` you should pick a number that is not yet in use. |
69 | 69 | ||
70 | Do change the `MANUFACTURER`, `PRODUCT`, and `DESCRIPTION` lines to accurately reflect your keyboard. | 70 | Do change the `MANUFACTURER` and `PRODUCT` lines to accurately reflect your keyboard. |
71 | 71 | ||
72 | ```c | 72 | ```c |
73 | #define VENDOR_ID 0xFEED | 73 | #define VENDOR_ID 0xFEED |
@@ -75,7 +75,6 @@ Do change the `MANUFACTURER`, `PRODUCT`, and `DESCRIPTION` lines to accurately r | |||
75 | #define DEVICE_VER 0x0001 | 75 | #define DEVICE_VER 0x0001 |
76 | #define MANUFACTURER You | 76 | #define MANUFACTURER You |
77 | #define PRODUCT my_awesome_keyboard | 77 | #define PRODUCT my_awesome_keyboard |
78 | #define DESCRIPTION A custom keyboard | ||
79 | ``` | 78 | ``` |
80 | 79 | ||
81 | ?> Windows and macOS will display the `MANUFACTURER` and `PRODUCT` in the list of USB devices. `lsusb` on Linux instead takes these from the list maintained by the [USB ID Repository](http://www.linux-usb.org/usb-ids.html) by default. `lsusb -v` will show the values reported by the device, and they are also present in kernel logs after plugging it in. | 80 | ?> Windows and macOS will display the `MANUFACTURER` and `PRODUCT` in the list of USB devices. `lsusb` on Linux instead takes these from the list maintained by the [USB ID Repository](http://www.linux-usb.org/usb-ids.html) by default. `lsusb -v` will show the values reported by the device, and they are also present in kernel logs after plugging it in. |
diff --git a/docs/ja/config_options.md b/docs/ja/config_options.md index 9e0dd7147..55ee2cfbe 100644 --- a/docs/ja/config_options.md +++ b/docs/ja/config_options.md | |||
@@ -48,8 +48,6 @@ QMK ã§ã®å…¨ã¦ã®åˆ©ç”¨å¯èƒ½ãªè¨å®šã«ã¯ãƒ‡ãƒ•ォルトãŒã‚りã¾ã™ã€‚ã | |||
48 | * 一般的ã«ã€èª°ã‚‚ã—ãã¯ã©ã®ãƒ–ランドãŒãƒœãƒ¼ãƒ‰ã‚’作æˆã—ãŸã‹ | 48 | * 一般的ã«ã€èª°ã‚‚ã—ãã¯ã©ã®ãƒ–ランドãŒãƒœãƒ¼ãƒ‰ã‚’作æˆã—ãŸã‹ |
49 | * `#define PRODUCT Board` | 49 | * `#define PRODUCT Board` |
50 | * ã‚ーボードã®åå‰ | 50 | * ã‚ーボードã®åå‰ |
51 | * `#define DESCRIPTION a keyboard` | ||
52 | * ã‚ーボードã®ç°¡å˜ãªèª¬æ˜Ž | ||
53 | * `#define MATRIX_ROWS 5` | 51 | * `#define MATRIX_ROWS 5` |
54 | * ã‚ーボードã®ãƒžãƒˆãƒªãƒƒã‚¯ã‚¹ã®è¡Œã®æ•° | 52 | * ã‚ーボードã®ãƒžãƒˆãƒªãƒƒã‚¯ã‚¹ã®è¡Œã®æ•° |
55 | * `#define MATRIX_COLS 15` | 53 | * `#define MATRIX_COLS 15` |
diff --git a/docs/ja/hardware_avr.md b/docs/ja/hardware_avr.md index fecbfd71f..0cba943c1 100644 --- a/docs/ja/hardware_avr.md +++ b/docs/ja/hardware_avr.md | |||
@@ -73,7 +73,7 @@ or open the directory in your favourite text editor. | |||
73 | 73 | ||
74 | `config.h` ã®å…ˆé ã«ã¯ USB ã«é–¢ã™ã‚‹è¨å®šãŒã‚りã¾ã™ã€‚ã“れらã¯ã‚ーボード㌠OS ã‹ã‚‰ã©ã®ã‚ˆã†ã«è¦‹ãˆã‚‹ã‹ã‚’制御ã—ã¦ã„ã¾ã™ã€‚変更ã™ã‚‹ç†ç”±ãŒãªã„å ´åˆã¯ã€`VENDOR_ID` ã‚’ `0xFEED` ã®ã¾ã¾ã«ã—ã¦ãŠãå¿…è¦ãŒã‚りã¾ã™ã€‚`PRODUCT_ID` ã«ã¯ã¾ã 使用ã•れã¦ã„ãªã„番å·ã‚’é¸ã°ãªã‘れã°ã„ã‘ã¾ã›ã‚“。 | 74 | `config.h` ã®å…ˆé ã«ã¯ USB ã«é–¢ã™ã‚‹è¨å®šãŒã‚りã¾ã™ã€‚ã“れらã¯ã‚ーボード㌠OS ã‹ã‚‰ã©ã®ã‚ˆã†ã«è¦‹ãˆã‚‹ã‹ã‚’制御ã—ã¦ã„ã¾ã™ã€‚変更ã™ã‚‹ç†ç”±ãŒãªã„å ´åˆã¯ã€`VENDOR_ID` ã‚’ `0xFEED` ã®ã¾ã¾ã«ã—ã¦ãŠãå¿…è¦ãŒã‚りã¾ã™ã€‚`PRODUCT_ID` ã«ã¯ã¾ã 使用ã•れã¦ã„ãªã„番å·ã‚’é¸ã°ãªã‘れã°ã„ã‘ã¾ã›ã‚“。 |
75 | 75 | ||
76 | `MANUFACTURER`〠`PRODUCT`〠`DESCRIPTION` ã‚’ã‚ーボードã«ã‚ã£ãŸè¨å®šã«å¤‰æ›´ã—ã¾ã™ã€‚ | 76 | `MANUFACTURER`〠`PRODUCT` ã‚’ã‚ーボードã«ã‚ã£ãŸè¨å®šã«å¤‰æ›´ã—ã¾ã™ã€‚ |
77 | 77 | ||
78 | ```c | 78 | ```c |
79 | #define VENDOR_ID 0xFEED | 79 | #define VENDOR_ID 0xFEED |
@@ -81,7 +81,6 @@ or open the directory in your favourite text editor. | |||
81 | #define DEVICE_VER 0x0001 | 81 | #define DEVICE_VER 0x0001 |
82 | #define MANUFACTURER You | 82 | #define MANUFACTURER You |
83 | #define PRODUCT my_awesome_keyboard | 83 | #define PRODUCT my_awesome_keyboard |
84 | #define DESCRIPTION A custom keyboard | ||
85 | ``` | 84 | ``` |
86 | 85 | ||
87 | ?> Windows ã‚„ macOS ã§ã¯ã€`MANUFACTURER` 㨠`PRODUCT` ㌠USBデãƒã‚¤ã‚¹ã®ãƒªã‚¹ãƒˆã«è¡¨ç¤ºã•れã¾ã™ã€‚Linux 上㮠`lsusb` ã§ã¯ã€ä»£ã‚りã«ãƒ‡ãƒ•ォルト㧠[USB ID Repository](http://www.linux-usb.org/usb-ids.html) ã«ã‚ˆã£ã¦ç¶æŒã•れã¦ã„るリストã‹ã‚‰ã“れらをå–å¾—ã—ã¾ã™ã€‚`lsusb -v` を使用ã™ã‚‹ã¨ãƒ‡ãƒã‚¤ã‚¹ã‹ã‚‰ç¤ºã•れãŸå€¤ã‚’表示ã—ã¾ã™ã€‚ã¾ãŸã€æŽ¥ç¶šã—ãŸã¨ãã®ã‚«ãƒ¼ãƒãƒ«ãƒã‚°ã«ã‚‚表示ã•れã¾ã™ã€‚ | 86 | ?> Windows ã‚„ macOS ã§ã¯ã€`MANUFACTURER` 㨠`PRODUCT` ㌠USBデãƒã‚¤ã‚¹ã®ãƒªã‚¹ãƒˆã«è¡¨ç¤ºã•れã¾ã™ã€‚Linux 上㮠`lsusb` ã§ã¯ã€ä»£ã‚りã«ãƒ‡ãƒ•ォルト㧠[USB ID Repository](http://www.linux-usb.org/usb-ids.html) ã«ã‚ˆã£ã¦ç¶æŒã•れã¦ã„るリストã‹ã‚‰ã“れらをå–å¾—ã—ã¾ã™ã€‚`lsusb -v` を使用ã™ã‚‹ã¨ãƒ‡ãƒã‚¤ã‚¹ã‹ã‚‰ç¤ºã•れãŸå€¤ã‚’表示ã—ã¾ã™ã€‚ã¾ãŸã€æŽ¥ç¶šã—ãŸã¨ãã®ã‚«ãƒ¼ãƒãƒ«ãƒã‚°ã«ã‚‚表示ã•れã¾ã™ã€‚ |