aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hardware_avr.md
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2020-07-16 15:49:18 +1000
committerGitHub <noreply@github.com>2020-07-16 15:49:18 +1000
commit72d327054744fa142469dbb5406ad61f5ad0a302 (patch)
treebbdf7937d6837ffdd323391f3dde2e9538fa447e /docs/hardware_avr.md
parent92d0a71af71973ac3f80398ed4f7f61dd97733b3 (diff)
downloadfirmware-72d327054744fa142469dbb5406ad61f5ad0a302.tar.gz
firmware-72d327054744fa142469dbb5406ad61f5ad0a302.tar.bz2
firmware-72d327054744fa142469dbb5406ad61f5ad0a302.zip
Remove `DESCRIPTION` (#9732)
Diffstat (limited to 'docs/hardware_avr.md')
-rw-r--r--docs/hardware_avr.md3
1 files changed, 1 insertions, 2 deletions
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
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.
-Do change the `MANUFACTURER`, `PRODUCT`, and `DESCRIPTION` lines to accurately reflect your keyboard.
+Do change the `MANUFACTURER` and `PRODUCT` lines to accurately reflect your keyboard.
```c
#define VENDOR_ID 0xFEED
@@ -75,7 +75,6 @@ Do change the `MANUFACTURER`, `PRODUCT`, and `DESCRIPTION` lines to accurately r
#define DEVICE_VER 0x0001
#define MANUFACTURER You
#define PRODUCT my_awesome_keyboard
-#define DESCRIPTION A custom keyboard
```
?> 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.