aboutsummaryrefslogtreecommitdiff
path: root/keyboards/clueboard/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/clueboard/readme.md')
-rw-r--r--keyboards/clueboard/readme.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/keyboards/clueboard/readme.md b/keyboards/clueboard/readme.md
index 6c29c09ec..4a76e2908 100644
--- a/keyboards/clueboard/readme.md
+++ b/keyboards/clueboard/readme.md
@@ -31,36 +31,36 @@ If you would like to use one of the alternative keymaps, or create your own, see
31 31
32## Clueboard 1.0 32## Clueboard 1.0
33 33
34If you have a first generation Clueboard (one with a black PCB) you will need to use the revision 1 code. To do so add `SUBPROJECT=rev1` to your make command, like this: 34If you have a first generation Clueboard (one with a black PCB) you will need to use the revision 1 code. To do so add `rev1` to your make command, like this:
35 35
36``` 36```
37$ make SUBPROJECT=rev1 37$ make rev1
38``` 38```
39 39
40And when flashing your keyboard: 40And when flashing your keyboard:
41 41
42``` 42```
43$ make SUBPROJECT=rev1 dfu 43$ make rev1-dfu
44``` 44```
45 45
46If you are flashing an alternative layout to your rev1, include both `SUBPROJECT=rev1` and `KEYMAP=<keymap>` in your command, for example when flashing max: 46If you are flashing an alternative layout to your rev1, include both `rev1` and `<keymap>` in your command, for example when flashing max:
47 47
48``` 48```
49$ make SUBPROJECT=rev1 KEYMAP=max dfu 49$ make rev1-max-dfu
50``` 50```
51 51
52## Alternate Keymaps 52## Alternate Keymaps
53 53
54There are many alternative and user-contributed layouts available in the [keymaps/](keymaps/) directory. To compile and flash an alternative you will want to add `KEYMAP=<keymap>` to your command: 54There are many alternative and user-contributed layouts available in the [keymaps/](keymaps/) directory. To compile and flash an alternative you will want to add `<keymap>` to your command:
55 55
56``` 56```
57$ make KEYMAP=skully 57$ make skully
58``` 58```
59 59
60And when flashing your keyboard, put `KEYMAP=<keymap>` between "make" and "dfu": 60And when flashing your keyboard, put `<keymap>` between "make" and "dfu":
61 61
62``` 62```
63$ make KEYMAP=skully dfu 63$ make skully-dfu
64``` 64```
65 65
66### Notable Layouts 66### Notable Layouts
@@ -76,15 +76,15 @@ These layouts are notable for one reason or another. If you are looking for idea
76There are a lot of possibilities when creating your own keymap, and the primary documentation for doing that is [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md. As a way to get started, here is the procedure I recommend: 76There are a lot of possibilities when creating your own keymap, and the primary documentation for doing that is [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md. As a way to get started, here is the procedure I recommend:
77 77
78* Copy `[keymaps/default](keymaps/default/)` to `keymaps/<your_layout>`. 78* Copy `[keymaps/default](keymaps/default/)` to `keymaps/<your_layout>`.
79* Compile the firmware (`$ make KEYMAP=<your_layout>`) 79* Compile the firmware (`$ make <your_layout>`)
80* Flash the firmware (`$ make KEYMAP=<your_layout> dfu`) 80* Flash the firmware (`$ make <your_layout>-dfu`)
81* Make sure everything works like the default keyboard 81* Make sure everything works like the default keyboard
82* Modify `keymaps/<your_layout>/readme.md` to tell others about your layout. 82* Modify `keymaps/<your_layout>/readme.md` to tell others about your layout.
83* Modify `keymaps/<your_layout>/keymap.c` to reflect your desired layout. 83* Modify `keymaps/<your_layout>/keymap.c` to reflect your desired layout.
84* Compile your new custom firmware (`$ make KEYMAP=<your_layout>`) 84* Compile your new custom firmware (`$ make <your_layout>`)
85** If you have warnings you may flash without fixing them, but something may not work right. 85** If you have warnings you may flash without fixing them, but something may not work right.
86** If you have any errors you must fix them before continuing. 86** If you have any errors you must fix them before continuing.
87* Flash the firmware (`$ make KEYMAP=<your_layout> dfu`) 87* Flash the firmware (`$ make <your_layout>-dfu`)
88 88
89## Share Your Keymap 89## Share Your Keymap
90 90