Henry-Hiles/qmk_userspace
1
0
Fork 0
forked from mirrors/qmk_userspace
Code Pull requests Activity

Update keyboard readme files with new makefile instructions

Browse source
This commit is contained in:
Fred Sundvik 2016-08-20 03:22:16 +03:00
parent b4c75569b0
commit da226e6126
16 changed files with 75 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

7
keyboards/atomic/readme.md
View file

@ -13,13 +13,14 @@ Download or clone the whole firmware and navigate to the keyboards/atomic folder
Depending on which keymap you would like to use, you will have to compile slightly differently.
### Default
To build with the default keymap, simply run `make`.
To build with the default keymap, simply run `make default`.
### Other Keymaps
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.
To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
```
$ make KEYMAP=[default|jack|<name>]
$ make [default|jack|<name>]
```
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.