Updated FAQ (markdown)

daktil_thumb_popravljen
tmk 2014-05-16 16:26:25 -07:00
parent 7fad7ddb0b
commit b828fff788
1 changed files with 27 additions and 2 deletions

29
FAQ.md
View File

@ -1,12 +1,37 @@
# Documents You Need To Read
Read these yet?
1. First **README** under top directory : https://github.com/tmk/tmk_keyboard/blob/master/README.md
2. For **Build**: https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md
3. And **README** under each project(keyboard/converter) directory
Note that you should read two **README**.
# Build # Build
## How to Build ## How to Build
See this first! See this first!
https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md
## 'make clean' needs after changing config.h In short,
To build with new **config.h** you need
$ make clean $ make clean
$ make [KEYMAP=...]
## 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 frimware.
$ make [KEYMAP=...]
Also you can always try `make clean` when you get other strange result during build.
## WINAVR is obsolete ## WINAVR is obsolete
It is no longer recommended and may cause some problem. It is no longer recommended and may cause some problem.