Add Makefiles for TMK converters.

[tmk_firmware.git] / doc / build.md

diff --git a/doc/build.md b/doc/build.md
index 5185e8032b4a6c3b7b8e2649ae1b88beb281a9e8..bfe5de9fd487928afb10aefd962cb92c7232efa2 100644 (file)
--- a/doc/build.md
+++ b/doc/build.md
@@ -40,7 +40,7 @@ Move to project directory in the firmware source.
 Build firmware using GNU `make` command. You'll see `<project>_<variant>.hex` file in that directory unless something unexpected occurs in build process.
 
 
-    mkae -f Makefile.<variant> clean
+    make -f Makefile.<variant> clean
     make -f Makefile.<variant>
 
 
@@ -71,14 +71,14 @@ Or to program with `dfu-programmer` run:
 #### FLIP GUI tutorial
 1. On menu bar click Device -> Select, then. `ATmega32u4`.
 2. On menu bar click Settings -> Communication -> USB, then click 'Open' button on 'USB Port Connection' dialog.
-At this point you'll see greyouted widgets on the app get colored and ready.
+At this point you'll see grey-outed widgets on the app get colored and ready.
 
 3. On menu bar click File -> Load HEX File, then select your firmware hex file on File Selector dialog.
 4. On 'Operations Flow' panel click 'Run' button to load the firmware binary to the chip. Note that you should keep 'Erase', 'Blank Check', 'Program' and 'Verify' check boxes selected.
 5. Re-plug USB cord or click 'Start Application' button to restart your controller.
 Done.
 
-See also these instaructions if you need.
+See also these instructions if you need.
 
 - <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
 - <http://www.atmel.com/Images/doc7769.pdf>
@@ -95,7 +95,7 @@ Or use this command if you have command line version of Teensy Loader installed.
 
 
 ### 4. Program with Other programmer
-You may want to use other programmer like `avrdude` with AVRISPmkII, Aruduino or USBasp. In that case you can still use make target `program` for build with configuring `PROGRAM_CMD` in Makefile.
+You may want to use other programmer like `avrdude` with AVRISPmkII, Arduino or USBasp. In that case you can still use make target `program` for build with configuring `PROGRAM_CMD` in Makefile.
 
     $ make -f Makefile.<variant> program
 
@@ -132,9 +132,10 @@ Optional. Note that ***comment out*** to disable them.
     COMMAND_ENABLE = yes        # Commands for debug and configuration
     SLEEP_LED_ENABLE = yes      # Breathing sleep LED during USB suspend
     #NKRO_ENABLE = yes          # USB Nkey Rollover - not yet supported in LUFA
+    #BACKLIGHT_ENABLE = yes     # Enable keyboard backlight functionality
 
 ### 3. Programmer
-Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`. Not needed if you use `FLIP`, `dfu-programmer` or `Teesy Loader`.
+Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`. Not needed if you use `FLIP`, `dfu-programmer` or `Teensy Loader`.
 
     # avrdude with AVRISPmkII
     PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex
@@ -157,8 +158,23 @@ Config.h Options
 
     /* Mechanical locking CapsLock support. Use KC_LCAP instead of KC_CAPS in keymap */
     #define CAPSLOCK_LOCKING_ENABLE
-    /* Locking CapsLock resynchronize hack */
+    /* Locking CapsLock re-synchronize hack */
     #define CAPSLOCK_LOCKING_RESYNC_ENABLE
 
+### 3. Disable Debug and Print
 
+    /* disable debug print */
+    #define NO_DEBUG
 
+    /* disable print */
+    #define NO_PRINT
+
+### 4. Disable Action Features
+
+    #define NO_ACTION_LAYER
+    #define NO_ACTION_TAPPING
+    #define NO_ACTION_ONESHOT
+    #define NO_ACTION_MACRO
+    #define NO_ACTION_FUNCTION
+
+***TBD***