diff options
Diffstat (limited to 'docs/getting_started_make_guide.md')
-rw-r--r-- | docs/getting_started_make_guide.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md index ecf030d1d..39ea34a60 100644 --- a/docs/getting_started_make_guide.md +++ b/docs/getting_started_make_guide.md | |||
@@ -4,7 +4,7 @@ The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, | |||
4 | 4 | ||
5 | * `<keyboard_folder>` is the path of the keyboard, for example `planck` | 5 | * `<keyboard_folder>` is the path of the keyboard, for example `planck` |
6 | * Use `all` to compile all keyboards | 6 | * Use `all` to compile all keyboards |
7 | * Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3` | 7 | * Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3` |
8 | * If the keyboard doesn't have any folders, it can be left out | 8 | * If the keyboard doesn't have any folders, it can be left out |
9 | * To compile the default folder, you can leave it out | 9 | * To compile the default folder, you can leave it out |
10 | * `<keymap>` is the name of the keymap, for example `algernon` | 10 | * `<keymap>` is the name of the keymap, for example `algernon` |
@@ -14,7 +14,7 @@ The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, | |||
14 | The `<target>` means the following | 14 | The `<target>` means the following |
15 | * If no target is given, then it's the same as `all` below | 15 | * If no target is given, then it's the same as `all` below |
16 | * `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck. | 16 | * `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck. |
17 | * `dfu`, `teensy` or `dfu-util`, compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme. | 17 | * `dfu`, `teensy` or `dfu-util`, compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme. |
18 | * **Note**: some operating systems need root access for these commands to work, so in that case you need to run for example `sudo make planck/rev4:default:dfu`. | 18 | * **Note**: some operating systems need root access for these commands to work, so in that case you need to run for example `sudo make planck/rev4:default:dfu`. |
19 | * `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems. | 19 | * `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems. |
20 | 20 | ||
@@ -30,7 +30,7 @@ The make command itself also has some additional options, type `make --help` for | |||
30 | Here are some examples commands | 30 | Here are some examples commands |
31 | 31 | ||
32 | * `make all:all` builds everything (all keyboard folders, all keymaps). Running just `make` from the `root` will also run this. | 32 | * `make all:all` builds everything (all keyboard folders, all keymaps). Running just `make` from the `root` will also run this. |
33 | * `make ergodox_infinity:algernon:clean` will clean the build output of the Ergodox Infinity keyboard. | 33 | * `make ergodox_infinity:algernon:clean` will clean the build output of the Ergodox Infinity keyboard. |
34 | * `make planck/rev4:default:dfu COLOR=false` builds and uploads the keymap without color output. | 34 | * `make planck/rev4:default:dfu COLOR=false` builds and uploads the keymap without color output. |
35 | 35 | ||
36 | ## `rules.mk` Options | 36 | ## `rules.mk` Options |
@@ -53,9 +53,9 @@ This allows you to use the system and audio control key codes. | |||
53 | 53 | ||
54 | `CONSOLE_ENABLE` | 54 | `CONSOLE_ENABLE` |
55 | 55 | ||
56 | This allows you to print messages that can be read using [`hid_listen`](https://www.pjrc.com/teensy/hid_listen.html). | 56 | This allows you to print messages that can be read using [`hid_listen`](https://www.pjrc.com/teensy/hid_listen.html). |
57 | 57 | ||
58 | By default, all debug (*dprint*) print (*print*, *xprintf*), and user print (*uprint*) messages will be enabled. This will eat up a significant portion of the flash and may make the keyboard .hex file too big to program. | 58 | By default, all debug (*dprint*) print (*print*, *xprintf*), and user print (*uprint*) messages will be enabled. This will eat up a significant portion of the flash and may make the keyboard .hex file too big to program. |
59 | 59 | ||
60 | To disable debug messages (*dprint*) and reduce the .hex file size, include `#define NO_DEBUG` in your `config.h` file. | 60 | To disable debug messages (*dprint*) and reduce the .hex file size, include `#define NO_DEBUG` in your `config.h` file. |
61 | 61 | ||
@@ -65,7 +65,7 @@ To disable print messages (*print*, *xprintf*) and **KEEP** user print messages | |||
65 | 65 | ||
66 | To see the text, open `hid_listen` and enjoy looking at your printed messages. | 66 | To see the text, open `hid_listen` and enjoy looking at your printed messages. |
67 | 67 | ||
68 | **NOTE:** Do not include *uprint* messages in anything other than your keymap code. It must not be used within the QMK system framework. Otherwise, you will bloat other people's .hex files. | 68 | **NOTE:** Do not include *uprint* messages in anything other than your keymap code. It must not be used within the QMK system framework. Otherwise, you will bloat other people's .hex files. |
69 | 69 | ||
70 | Consumes about 400 bytes. | 70 | Consumes about 400 bytes. |
71 | 71 | ||