You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove all Makefiles from the keyboards directory. (#1660)
* Remove all Makefiles from the keyboards directory.
* update keymaps added in the last 8 days
* Ignore keyboard/keymap makefiles
* update hand_wire to reflect our new Makefile-less reality
* Update the make guide to reflect the new reality
* move planck keymap options to rules.mk
* update planck keymaps 4real
* trigger travis
* add back build_keyboard.mk
* restore changes to build_keyboard
Copy file name to clipboardExpand all lines: docs/getting_started_make_guide.md
+9-39
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,6 @@
1
1
# More detailed make instruction
2
2
3
-
The full syntax of the `make` command is the following, but parts of the command can be left out if you run it from other directories than the `root` (as you might already have noticed by reading the simple instructions).
The full syntax of the `make` command is `<keyboard>-<subproject>-<keymap>-<target>`, where:
6
4
7
5
*`<keyboard>` is the name of the keyboard, for example `planck`
8
6
* Use `allkb` to compile all keyboards
@@ -14,24 +12,13 @@ The full syntax of the `make` command is the following, but parts of the command
14
12
* Use `allkm` to compile all keymaps
15
13
*`<target>` will be explained in more detail below.
16
14
17
-
**Note:** When you leave some parts of the command out, you should also remove the dash (`-`).
18
-
19
-
As mentioned above, there are some shortcuts, when you are in a:
20
-
21
-
*`keyboard` folder, the command will automatically fill the `<keyboard>` part. So you only need to type `<subproject>-<keymap>-<target>`
22
-
*`subproject` folder, it will fill in both `<keyboard>` and `<subproject>`
23
-
*`keymap` folder, then `<keyboard>` and `<keymap>` will be filled in. If you need to specify the `<subproject>` use the following syntax `<subproject>-<target>`
24
-
* Note in order to support this shortcut, the keymap needs its own Makefile
25
-
*`keymap` folder of a `subproject`, then everything except the `<target>` will be filled in
26
-
27
15
The `<target>` means the following
28
16
* If no target is given, then it's the same as `all` below
29
-
*`all` compiles the keyboard and generates a `<keyboard>_<keymap>.hex` file in whichever folder you run `make` from. These files are ignored by git, so don't worry about deleting them when committing/creating pull requests.
30
-
*`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 Infinity 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** that some operating systems needs root access for these commands to work, so in that case you need to run for example `sudo make dfu`.
17
+
*`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.
18
+
*`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.
19
+
***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`.
31
20
*`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.
32
21
33
-
Some other targets are supported but, but not important enough to be documented here. Check the source code of the make files for more information.
34
-
35
22
You can also add extra options at the end of the make command line, after the target
36
23
37
24
*`make COLOR=false` - turns off color output
@@ -44,25 +31,10 @@ The make command itself also has some additional options, type `make --help` for
44
31
Here are some examples commands
45
32
46
33
*`make allkb-allsp-allkm` builds everything (all keyboards, all subprojects, all keymaps). Running just `make` from the `root` will also run this.
47
-
*`make` from within a `keyboard` directory, is the same as `make keyboard-allsp-allkm`, which compiles all subprojects and keymaps of the keyboard. **NOTE** that this behaviour has changed. Previously it compiled just the default keymap.
48
-
*`make ergodox-infinity-algernon-clean` will clean the build output of the Ergodox Infinity keyboard. This example uses the full syntax and can be run from any folder with a `Makefile`
49
-
*`make dfu COLOR=false` from within a keymap folder, builds and uploads the keymap, but without color output.
50
-
51
-
# The `Makefile`
34
+
*`make ergodox-infinity-algernon-clean` will clean the build output of the Ergodox Infinity keyboard.
35
+
*`make planck-rev4-default-dfu COLOR=false` builds and uploads the keymap without color output.
52
36
53
-
There are 5 different `make` and `Makefile` locations:
The root contains the code used to automatically figure out which keymap or keymaps to compile based on your current directory and commandline arguments. It's considered stable, and shouldn't be modified. The keyboard one will contain the MCU set-up and default settings for your keyboard, and shouldn't be modified unless you are the producer of that keyboard. The keymap Makefile can be modified by users, and is optional. It is included automatically if it exists. You can see an example [here](https://github.com/qmk/qmk_firmware/blob/master/doc/keymap_makefile_example.mk) - the last few lines are the most important. The settings you set here will override any defaults set in the keyboard Makefile. **The file is required if you want to run `make` in the keymap folder.**
62
-
63
-
For keyboards and subprojects, the make files are split in two parts `Makefile` and `rules.mk`. All settings can be found in the `rules.mk` file, while the `Makefile` is just there for support and including the root `Makefile`. Keymaps contain just one `Makefile` for simplicity.
64
-
65
-
## Makefile options
37
+
## `rules.mk` options
66
38
67
39
Set these variables to `no` to disable them, and `yes` to enable them.
68
40
@@ -164,8 +136,6 @@ This enables [key lock](key_lock.md). This consumes an additional 260 bytes.
164
136
165
137
## Customizing Makefile options on a per-keymap basis
166
138
167
-
If your keymap directory has a file called `Makefile` (note the filename), any Makefile options you set in that file will take precedence over other Makefile options for your particular keyboard.
168
-
169
-
So let's say your keyboard's makefile has `BACKLIGHT_ENABLE = yes` (or maybe doesn't even list the `BACKLIGHT_ENABLE` option, which would cause it to be off). You want your particular keymap to not have the debug console, so you make a file called `Makefile` and specify `BACKLIGHT_ENABLE = no`.
139
+
If your keymap directory has a file called `rules.mk` any options you set in that file will take precedence over other `rules.mk` options for your particular keyboard.
170
140
171
-
You can use the `docs/keymap_makefile_example.md` as a template/starting point.
141
+
So let's say your keyboard's `rules.mk` has `BACKLIGHT_ENABLE = yes`. You want your particular keyboard to not have the backlight, so you make a file called `rules.mk` and specify `BACKLIGHT_ENABLE = no`.
Copy file name to clipboardExpand all lines: docs/hand_wire.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -271,9 +271,9 @@ This would require our `KEYMAP` definition to look like this:
271
271
272
272
Notice how the `k11` and `KC_NO` switched places to represent the wiring, and the unused final column on the bottom row. Sometimes it'll make more sense to put a keyswitch on a particular column, but in the end, it won't matter, as long as all of them are accounted for. You can use this process to write out the `KEYMAP` for your entire keyboard - be sure to remember that your keyboard is actually backwards when looking at the underside of it.
273
273
274
-
### keymaps/default.c
274
+
### keymaps/<variant>/default.c
275
275
276
-
This is the actual keymap for your keyboard, and the main place you'll make changes as you perfect your layout. `default.c` is the file that gets pull by default when typing `make`, but you can make other files as well, and specify them by typing `make KEYMAP=<variant>`, which will pull `keymaps/<variant>.c`.
276
+
This is the actual keymap for your keyboard, and the main place you'll make changes as you perfect your layout. `default.c` is the file that gets pull by default when typing `make`, but you can make other files as well, and specify them by typing `make handwired-<keyboard>-<variant>`, which will pull `keymaps/<variant>/keymap.c`.
277
277
278
278
The basis of a keymap is its layers - by default, layer 0 is active. You can activate other layers, the highest of which will be referenced first. Let's start with our base layer.
0 commit comments