summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortmk <tmk@users.noreply.github.com>2014-05-16 16:26:25 -0700
committertmk <tmk@users.noreply.github.com>2014-05-16 16:26:25 -0700
commitb828fff7888239838a177b7caae0859688a608cf (patch)
tree20adf730bc746dbe6886e16f3f2416d99ca6f844
parent7fad7ddb0bc9e256b7c2e25a96b226014d1c904b (diff)
downloadqmk_firmware-b828fff7888239838a177b7caae0859688a608cf.tar.gz
qmk_firmware-b828fff7888239838a177b7caae0859688a608cf.zip
Updated FAQ (markdown)
-rw-r--r--FAQ.md29
1 files changed, 27 insertions, 2 deletions
diff --git a/FAQ.md b/FAQ.md
index edcdbba954..2dc23b84a1 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -1,13 +1,38 @@
+# 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
## How to Build
See this first!
https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md
-## 'make clean' needs after changing config.h
-To build with new **config.h** you need
+In short,
+
+ $ 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
It is no longer recommended and may cause some problem.
See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).