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.md63
1 files changed, 6 insertions, 57 deletions
diff --git a/docs/faq_build.md b/docs/faq_build.md
index ba8b52af1..ebe8caccd 100644
--- a/docs/faq_build.md
+++ b/docs/faq_build.md
@@ -1,5 +1,6 @@
1## READ FIRST 1# Frequently Asked Build Questions
2- https://github.com/qmk/qmk_firmware/blob/master/docs/build_guide.md 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).
3 4
4In short, 5In short,
5 6
@@ -8,12 +9,10 @@ In short,
8 $ make [-f Makefile.<variant>] [KEYMAP=...] dfu 9 $ make [-f Makefile.<variant>] [KEYMAP=...] dfu
9 10
10 11
11## Can't program on Linux and Mac 12## Can't program on Linux
12You will need proper permission to operate a device. For Linux users see udev rules below. 13You will need proper permission to operate a device. For Linux users see udev rules below.
13Easy 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.
14 15
15https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man8/sudo.8.html
16
17In short when your controller is ATMega32u4, 16In short when your controller is ATMega32u4,
18 17
19 $ sudo dfu-programmer atmega32u4 erase --force 18 $ sudo dfu-programmer atmega32u4 erase --force
@@ -26,63 +25,14 @@ or just
26 25
27But to run `make` with root privilege is not good idea. Use former method as possible. 26But to run `make` with root privilege is not good idea. Use former method as possible.
28 27
29## Do 'make clean' before 'make'
30You'll need `make clean` after you edit **config.h** or change options like `KEYMAP`.
31
32Frist remove all files made in previous build,
33
34 $ make clean
35
36then build new firmware.
37
38 $ make [KEYMAP=...]
39
40Also you can always try `make clean` when you get other strange result during build.
41
42
43## WINAVR is obsolete 28## WINAVR is obsolete
44It is no longer recommended and may cause some problem. 29It is no longer recommended and may cause some problem.
45See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99). 30See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
46 31
47## USB stack: LUFA or PJRC?
48Use **LUFA**.
49
50**PJRC** stack won't be supported actively anymore. There is no reason to hesitate to use LUFA except for binary size(about 1KB lager?). But **PJRC** is still very useful for debug and development purpose.
51See also [Issue #50](https://github.com/tmk/tmk_keyboard/issues/50) and [Issue #58](https://github.com/tmk/tmk_keyboard/issues/58).
52
53## Edit configuration but not change
54You will need followings after editing `CONSOLE_ENABLE`, `NKRO_ENABLE`, `EXTRAKEY_ENABLE` or `MOUSEKEY_ENABLE` option in **Makefile**.
55
56### 1. make clean
57This will be needed when you edit **config.h**.
58
59### 2. Remove Drivers from Device Manager(Windows)
60**Windows only.** Linux, OSX and other OS's doesn't require this. It looks like Windows keeps using driver installed when device was connected first time even after the device changes its configuration. To load proper drivers for new configuration you need to remove existent drivers from **Drvice Manager**.
61
62### 3. Build with different VID:PID
63**Windows only.** If method 2. does't work fou you try this. Change Vendor ID or Product ID in **config.h** and build firmware. Windows should recognize it as whole new device and start drivers install process.
64
65### 4. Just try other ports
66This will be useful and the easiest workaround for **Windows**.
67
68
69
70## USB VID and PID 32## USB VID and PID
71You 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. 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.
72 34
73For example TMK uses following numbers by default. 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.
74```
75keyboard:
76hhkb: FEED:CAFE
77gh60: FEED:6060
78
79converter:
80x68k: FEED:6800
81ps2: FEED:6512
82adb: FEED:0ADB
83ibm4704: FEED:4704
84pc98: FEED:9898
85```
86 36
87Also see this. 37Also see this.
88https://github.com/tmk/tmk_keyboard/issues/150 38https://github.com/tmk/tmk_keyboard/issues/150
@@ -112,7 +62,6 @@ SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
112``` 62```
113 63
114 64
115
116## Cortex: cstddef: No such file or directory 65## Cortex: cstddef: No such file or directory
117GCC 4.8 of Ubuntu 14.04 had this problem and had to update to 4.9 with this PPA. 66GCC 4.8 of Ubuntu 14.04 had this problem and had to update to 4.9 with this PPA.
118https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded 67https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded
@@ -148,4 +97,4 @@ Note that Teensy2.0++ bootloader size is 2048byte. Some Makefiles may have wrong
148# LUFA bootloader 4096 97# LUFA bootloader 4096
149# USBaspLoader 2048 98# USBaspLoader 2048
150OPT_DEFS += -DBOOTLOADER_SIZE=2048 99OPT_DEFS += -DBOOTLOADER_SIZE=2048
151``` \ No newline at end of file 100```