diff options
Diffstat (limited to 'keyboards/atomic/readme.md')
| -rw-r--r-- | keyboards/atomic/readme.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/keyboards/atomic/readme.md b/keyboards/atomic/readme.md index ab1e7ba1f..674dcf113 100644 --- a/keyboards/atomic/readme.md +++ b/keyboards/atomic/readme.md | |||
| @@ -13,13 +13,14 @@ Download or clone the whole firmware and navigate to the keyboards/atomic folder | |||
| 13 | Depending on which keymap you would like to use, you will have to compile slightly differently. | 13 | Depending on which keymap you would like to use, you will have to compile slightly differently. |
| 14 | 14 | ||
| 15 | ### Default | 15 | ### Default |
| 16 | To build with the default keymap, simply run `make`. | 16 | To build with the default keymap, simply run `make default`. |
| 17 | 17 | ||
| 18 | ### Other Keymaps | 18 | ### Other Keymaps |
| 19 | Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a file in the keymaps folder named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files. | 19 | Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a file in the keymaps folder named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files. |
| 20 | 20 | ||
| 21 | To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like: | 21 | To build the firmware binary hex file with a keymap just do `make` with a keymap like this: |
| 22 | |||
| 22 | ``` | 23 | ``` |
| 23 | $ make KEYMAP=[default|jack|<name>] | 24 | $ make [default|jack|<name>] |
| 24 | ``` | 25 | ``` |
| 25 | Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. | 26 | Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. |
