Add a help message to new_project.sh

[qmk_firmware.git] / README.md

diff --git a/README.md b/README.md
index 0066d0189b7289a3eb43c918550eff7c9bb69bd0..6a6bbed40b0097ba50b0168d8a554de56da5e719 100644 (file)
--- a/README.md
+++ b/README.md
@@ -12,8 +12,8 @@ The documentation below explains QMK customizations and elaborates on some of th
 
 ## Getting started
 
-* **If you're looking to customize a keyboard that currently runs QMK or TMK** , find your keyboard's directory under `/keyboard/` and read the README file. This will get you all set up.
-* Read the [QUICK_START.md](QUICK_START.md) if you want to hit the ground running with minimal fuss or you aren't a technical person and you just want to build the firmware with the least amount of hassle possible.
+* [BUILD_GUIDE.md](BUILD_GUIDE.md) contains instructions to set up a build environment, build the firmware, and deploy it to a keyboard. Once your build environment has been set up, all `make` commands to actually build the firmware must be run from a folder in `keyboard/`.
+* If you're looking to customize a keyboard that currently runs QMK or TMK, find your keyboard's directory under `keyboard/` and run the make commands from there.
 * If you're looking to apply this firmware to an entirely new hardware project (a new kind of keyboard), you can create your own Quantum-based project by using `./new_project.sh <project_name>`, which will create `/keyboard/<project_name>` with all the necessary components for a Quantum project.
 
 You have access to a bunch of goodies! Check out the Makefile to enable/disable some of the features. Uncomment the `#` to enable them. Setting them to `no` does nothing and will only confuse future you.
@@ -138,7 +138,7 @@ Note: Using macros to have your keyboard send passwords for you is possible, but
 
 To get more control over the keys/actions your keyboard takes, the following functions are available to you in the `action_get_macro` function block:
 
-#### `record->event.pressed`
+* `record->event.pressed`
 
 This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
 
@@ -150,35 +150,31 @@ if (record->event.pressed) {
 }
 ```
 
-#### `record->tap.count`
-
-The number taps that a certain key gets without interruption. This value can also be reset by assigning it `0`.
-
-#### `register_code(<kc>);`
+* `register_code(<kc>);`
 
 This sends the `<kc>` keydown event to the computer. Some examples would be `KC_ESC`, `KC_C`, `KC_4`, and even modifiers such as `KC_LSFT` and `KC_LGUI`.
 
-#### `unregister_code(<kc>);`
+* `unregister_code(<kc>);`
 
 Parallel to `register_code` function, this sends the `<kc>` keyup event to the computer. If you don't use this, the key will be held down until it's sent.
 
-#### `layer_on(<n>);`
+* `layer_on(<n>);`
 
 This will turn on the layer `<n>` - the higher layer number will always take priority. Make sure you have `KC_TRNS` for the key you're pressing on the layer you're switching to, or you'll get stick there unless you have another plan.
 
-#### `layer_off(<n>);`
+* `layer_off(<n>);`
 
 This will turn off the layer `<n>`.
 
-#### `clear_keyboard();`
+* `clear_keyboard();`
 
 This will clear all mods and keys currently pressed.
 
-#### `clear_mods();`
+* `clear_mods();`
 
 This will clear all mods currently pressed.
 
-#### `clear_keyboard_but_mods();`
+* `clear_keyboard_but_mods();`
 
 This will clear all keys besides the mods currently pressed.
 
@@ -196,7 +192,7 @@ if (timer_elapsed(key_timer) < 100) {
 }
 ```
 
-It's best to declare the `static uint16_t start;` outside of the macro block (top of file, etc). 
+It's best to declare the `static uint16_t key_timer;` outside of the macro block (top of file, etc). 
 
 ## Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc)
 
@@ -313,3 +309,4 @@ what things are (and likely aren't) too risky.
 - EEPROM has around a 100000 write cycle.  You shouldn't rewrite the
   firmware repeatedly and continually; that'll burn the EEPROM
   eventually.
+                                       
\ No newline at end of file