aboutsummaryrefslogtreecommitdiff
path: root/docs/faq_build.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/faq_build.md')
-rw-r--r--docs/faq_build.md21
1 files changed, 6 insertions, 15 deletions
diff --git a/docs/faq_build.md b/docs/faq_build.md
index ebe8caccd..353e80594 100644
--- a/docs/faq_build.md
+++ b/docs/faq_build.md
@@ -1,17 +1,9 @@
1# Frequently Asked Build Questions 1# Frequently Asked Build Questions
2 2
3This page covers questions about building QMK. If you have not yet you should read the [Build Guide](https://github.com/qmk/qmk_firmware/blob/master/docs/build_guide.md). 3This page covers questions about building QMK. If you have not yet you should read the [Build Environment Setup](build_environment_setup.md) and [Make Instructions](make_instructions.md) guides.
4
5In short,
6
7 $ make [-f Makefile.<variant>] [KEYMAP=...] clean
8 $ make [-f Makefile.<variant>] [KEYMAP=...]
9 $ make [-f Makefile.<variant>] [KEYMAP=...] dfu
10
11 4
12## Can't program on Linux 5## Can't program on Linux
13You will need proper permission to operate a device. For Linux users see udev rules below. 6You will need proper permission to operate a device. For Linux users see udev rules below. Easy way is to use `sudo` command, if you are not familiar with this command check its manual with `man sudo` or this page on line.
14Easy way is to use `sudo` command, if you are not familiar with this command check its manual with `man sudo` or this page on line.
15 7
16In short when your controller is ATMega32u4, 8In short when your controller is ATMega32u4,
17 9
@@ -21,16 +13,16 @@ In short when your controller is ATMega32u4,
21 13
22or just 14or just
23 15
24 $ sudo make dfu 16 $ sudo make <keyboard>-<keymap>-dfu
25 17
26But to run `make` with root privilege is not good idea. Use former method as possible. 18But to run `make` with root privilege is not good idea. Use former method if possible.
27 19
28## WINAVR is obsolete 20## WINAVR is obsolete
29It is no longer recommended and may cause some problem. 21It is no longer recommended and may cause some problem.
30See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99). 22See [TMK Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
31 23
32## USB VID and PID 24## USB VID and PID
33You can use any ID you want with editing `config.h`. Using any presumably unused ID will be no problem in fact except for very least chance of collision with other product. 25You can use any ID you want with editing `config.h`. Using any presumably unused ID will be no problem in fact except for very low chance of collision with other product.
34 26
35Most boards in QMK use `0xFEED` as the vendor ID. You should look through other keyboards to make sure you pick a unique Product ID. 27Most boards in QMK use `0xFEED` as the vendor ID. You should look through other keyboards to make sure you pick a unique Product ID.
36 28
@@ -41,7 +33,6 @@ You can buy a really unique VID:PID here. I don't think you need this for person
41- http://www.obdev.at/products/vusb/license.html 33- http://www.obdev.at/products/vusb/license.html
42- http://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1 34- http://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1
43 35
44
45## Linux udev rules 36## Linux udev rules
46On Linux you need proper privilege to access device file of MCU, you'll have to use `sudo` when flashing firmware. You can circumvent this with placing these files in `/etc/udev/rules.d/`. 37On Linux you need proper privilege to access device file of MCU, you'll have to use `sudo` when flashing firmware. You can circumvent this with placing these files in `/etc/udev/rules.d/`.
47 38