diff options
Diffstat (limited to 'docs/getting_started_make_guide.md')
| -rw-r--r-- | docs/getting_started_make_guide.md | 27 |
1 files changed, 13 insertions, 14 deletions
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md index 97383d950a..b6f0f4ee27 100644 --- a/docs/getting_started_make_guide.md +++ b/docs/getting_started_make_guide.md @@ -1,22 +1,21 @@ # More detailed make instruction -The full syntax of the `make` command is `<keyboard>-<subproject>-<keymap>-<target>`, where: - -* `<keyboard>` is the name of the keyboard, for example `planck` - * Use `allkb` to compile all keyboards -* `<subproject>` is the name of the subproject (revision or sub-model of the keyboard). For example, for Planck it can be `rev3` or `rev4`. - * If the keyboard doesn't have any subprojects, it can be left out - * To compile the default subproject, you can leave it out, or specify `defaultsp` - * Use `allsp` to compile all subprojects +The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, where: + +* `<keyboard_folder>` is the path of the keyboard, for example `planck` + * Use `all` to compile all keyboards + * Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3` + * If the keyboard doesn't have any folders, it can be left out + * To compile the default folder, you can leave it out * `<keymap>` is the name of the keymap, for example `algernon` - * Use `allkm` to compile all keymaps + * Use `all` to compile all keymaps * `<target>` will be explained in more detail below. The `<target>` means the following * If no target is given, then it's the same as `all` below -* `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck-rev4-default-all` will generate a single .hex, while `make planck-rev-all` will generate a hex for every keymap available to the planck. +* `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default:all` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck. * `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. - * **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`. + * **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`. * `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. You can also add extra options at the end of the make command line, after the target @@ -30,9 +29,9 @@ The make command itself also has some additional options, type `make --help` for Here are some examples commands -* `make allkb-allsp-allkm` builds everything (all keyboards, all subprojects, all keymaps). Running just `make` from the `root` will also run this. -* `make ergodox-infinity-algernon-clean` will clean the build output of the Ergodox Infinity keyboard. -* `make planck-rev4-default-dfu COLOR=false` builds and uploads the keymap without color output. +* `make all:all` builds everything (all keyboard folders, all keymaps). Running just `make` from the `root` will also run this. +* `make ergodox_infinity:algernon:clean` will clean the build output of the Ergodox Infinity keyboard. +* `make planck/rev4:default:dfu COLOR=false` builds and uploads the keymap without color output. ## `rules.mk` options |