add description of new option to docs and add option (commented out) into template.

[qmk_firmware.git] / docs / faq_build.md

diff --git a/docs/faq_build.md b/docs/faq_build.md
index ba8b52af15719df887c051d6505485289330435a..ebe8caccd1fc90fb8405864872d7bc3ca1a15988 100644 (file)
--- a/docs/faq_build.md
+++ b/docs/faq_build.md
@@ -1,5 +1,6 @@
-## READ FIRST
-- https://github.com/qmk/qmk_firmware/blob/master/docs/build_guide.md
+# Frequently Asked Build Questions
+
+This 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).
 
 In short,
 
@@ -8,12 +9,10 @@ In short,
     $ make [-f Makefile.<variant>] [KEYMAP=...] dfu
 
 
-## Can't program on Linux and Mac
+## Can't program on Linux
 You 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.
 
-https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man8/sudo.8.html
-
 In short when your controller is ATMega32u4,
     
     $ sudo dfu-programmer atmega32u4 erase --force
@@ -26,63 +25,14 @@ or just
 
 But to run `make` with root privilege is not good idea. Use former method as possible.
 
-## Do 'make clean' before 'make'
-You'll need `make clean` after you edit **config.h** or change options like `KEYMAP`.
-
-Frist remove all files made in previous build,
-
-    $ make clean
-
-then build new firmware. 
-
-    $ make [KEYMAP=...]
-
-Also you can always try `make clean` when you get other strange result during build.
-
-
 ## WINAVR is obsolete
 It is no longer recommended and may cause some problem.
 See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
 
-## USB stack: LUFA or PJRC?
-Use **LUFA**.
-
-**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.
-See also [Issue #50](https://github.com/tmk/tmk_keyboard/issues/50) and [Issue #58](https://github.com/tmk/tmk_keyboard/issues/58).
-
-## Edit configuration but not change
-You will need followings after editing `CONSOLE_ENABLE`, `NKRO_ENABLE`, `EXTRAKEY_ENABLE` or `MOUSEKEY_ENABLE` option in **Makefile**.
-
-### 1. make clean
-This will be needed when you edit **config.h**.
-
-### 2. Remove Drivers from Device Manager(Windows)
-**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**.
-
-### 3. Build with different VID:PID
-**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.
-
-### 4. Just try other ports
-This will be useful and the easiest workaround for **Windows**.
-
-
-
 ## USB VID and PID
 You 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.
 
-For example TMK uses following numbers by default.
-```
-keyboard:
-hhkb: FEED:CAFE
-gh60: FEED:6060
-
-converter:
-x68k: FEED:6800
-ps2: FEED:6512
-adb: FEED:0ADB
-ibm4704: FEED:4704
-pc98: FEED:9898
-```
+Most boards in QMK use `0xFEED` as the vendor ID. You should look through other keyboards to make sure you pick a unique Product ID.
 
 Also see this.
 https://github.com/tmk/tmk_keyboard/issues/150
@@ -112,7 +62,6 @@ SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
 ```
 
 
-
 ## Cortex: cstddef: No such file or directory
 GCC 4.8 of Ubuntu 14.04 had this problem and had to update to 4.9 with this PPA.
 https://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
 #   LUFA bootloader  4096         
 #   USBaspLoader     2048         
 OPT_DEFS += -DBOOTLOADER_SIZE=2048
-```
\ No newline at end of file
+```