Updated License Clarification (markdown)

[qmk_firmware.git] / FAQ-Build.md

diff --git a/FAQ-Build.md b/FAQ-Build.md
index 074272d11ae4eb6c42696723d0444c6e86b58fde..2e21cb69214a1d1db236dd6b2dfeee9388c15e7b 100644 (file)
--- a/FAQ-Build.md
+++ b/FAQ-Build.md
@@ -1,5 +1,5 @@
 ## READ FIRST
-- https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md
+- https://github.com/jackhumbert/qmk_firmware/blob/master/doc/BUILD_GUIDE.md
 
 In short,
 
@@ -14,16 +14,17 @@ Easy way is to use `sudo` command, if you are not familiar with this command che
 
 https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man8/sudo.8.html
 
-in short,
+In short when your controller is ATMega32u4,
     
     $ sudo dfu-programmer atmega32u4 erase --force
-    $ sudo dfu-programmer atmega32u4 flash hhkb_rn42.hex
+    $ sudo dfu-programmer atmega32u4 flash your.hex
     $ sudo dfu-programmer atmega32u4 reset
 
-or 
+or just
 
     $ sudo make dfu
 
+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`.
@@ -133,4 +134,18 @@ avr-gcc -c -mmcu=atmega32u2 -gdwarf-2 -DF_CPU=16000000UL -DINTERRUPT_CONTROL_END
 ../../tmk_core/protocol/lufa/lufa.c:575: error: (Each undeclared identifier is reported only once
 ../../tmk_core/protocol/lufa/lufa.c:575: error: for each function it appears in.)
 make: *** [obj_alps64/protocol/lufa/lufa.o] Error 1
+```
+
+
+## BOOTLOADER_SIZE for AVR
+Note that Teensy2.0++ bootloader size is 2048byte. Some Makefiles may have wrong comment.
+
+```
+# Boot Section Size in *bytes*    
+#   Teensy halfKay   512          
+#   Teensy++ halfKay 2048         
+#   Atmel DFU loader 4096       (TMK Alt Controller)
+#   LUFA bootloader  4096         
+#   USBaspLoader     2048         
+OPT_DEFS += -DBOOTLOADER_SIZE=2048
 ```
\ No newline at end of file