aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/eclipse.md6
-rw-r--r--docs/feature_audio.md2
-rw-r--r--docs/feature_mouse_keys.md8
-rw-r--r--docs/keycodes.md2
4 files changed, 10 insertions, 8 deletions
diff --git a/docs/eclipse.md b/docs/eclipse.md
index c51df522d..2cb90647a 100644
--- a/docs/eclipse.md
+++ b/docs/eclipse.md
@@ -1,6 +1,6 @@
1# Setting up Eclipse for QMK Development 1# Setting up Eclipse for QMK Development
2 2
3[Eclipse](https://en.wikipedia.org/wiki/Eclipse_(software)) is an open-source [Integrated Development Environment](https://en.wikipedia.org/wiki/Integrated_development_environment) (IDE) widely used for Java development, but with an extensible plugin system that allows to customize it for other languages and usages. 3[Eclipse][1] is an open-source [Integrated Development Environment](https://en.wikipedia.org/wiki/Integrated_development_environment) (IDE) widely used for Java development, but with an extensible plugin system that allows to customize it for other languages and usages.
4 4
5Using an IDE such as Eclipse provides many advantages over a plain text editor, such as: 5Using an IDE such as Eclipse provides many advantages over a plain text editor, such as:
6* intelligent code completion 6* intelligent code completion
@@ -17,7 +17,7 @@ Note that this set-up has been tested on Ubuntu 16.04 only for the moment.
17 17
18# Prerequisites 18# Prerequisites
19## Build Environment 19## Build Environment
20Before starting, you must have followed the [Getting Started](home.md#getting-started) section corresponding to your system. In particular, you must have been able to build the firmware with [the `make` command](../#the-make-command). 20Before starting, you must have followed the [Getting Started](README.md#getting-started) section corresponding to your system. In particular, you must have been able to build the firmware with [the `make` command](../#the-make-command).
21 21
22## Java 22## Java
23Eclipse is a Java application, so you will need to install Java 8 or more recent to be able to run it. You may choose between the JRE or the JDK, the latter being useful if you intend to do Java development. 23Eclipse is a Java application, so you will need to install Java 8 or more recent to be able to run it. You may choose between the JRE or the JDK, the latter being useful if you intend to do Java development.
@@ -84,3 +84,5 @@ We will now configure a make target that cleans the project and builds the keyma
847. (Optional) Toggle the <kbd>Hide Empty Folders</kbd> icon button above the targets tree to only show your build target. 847. (Optional) Toggle the <kbd>Hide Empty Folders</kbd> icon button above the targets tree to only show your build target.
858. Double-click the build target you created to trigger a build. 858. Double-click the build target you created to trigger a build.
869. Select the <kbd>Console</kbd> view at the bottom to view the running build. 869. Select the <kbd>Console</kbd> view at the bottom to view the running build.
87
88 [1]: https://en.wikipedia.org/wiki/Eclipse_(software) \ No newline at end of file
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index c7133b295..5b11aa3ab 100644
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@@ -82,7 +82,7 @@ The pitch standard (`PITCH_STANDARD_A`) is 440.0f by default - to change this, a
82 82
83 #define PITCH_STANDARD_A 432.0f 83 #define PITCH_STANDARD_A 432.0f
84 84
85You can completely disable Music Mode as well. This is useful, if you're pressed for space on your controller. To disable it, add this to your `confid.h`: 85You can completely disable Music Mode as well. This is useful, if you're pressed for space on your controller. To disable it, add this to your `config.h`:
86 86
87 #define NO_MUSIC_MODE 87 #define NO_MUSIC_MODE
88 88
diff --git a/docs/feature_mouse_keys.md b/docs/feature_mouse_keys.md
index c4239b4da..9e7df929e 100644
--- a/docs/feature_mouse_keys.md
+++ b/docs/feature_mouse_keys.md
@@ -5,17 +5,17 @@ Mousekeys is a feature that allows you to emulate a mouse using your keyboard. Y
5 5
6## Adding Mousekeys to a Keymap 6## Adding Mousekeys to a Keymap
7 7
8There are two steps to adding Mousekeys support to your keyboard. You must enable support in the Makefile and you must map mouse actions to keys on your keyboard. 8There are two steps to adding Mousekeys support to your keyboard. You must enable support in the `rules.mk` file and you must map mouse actions to keys on your keyboard.
9 9
10### Adding Mousekeys Support in the `Makefile` 10### Adding Mousekeys Support in the `rules.mk`
11 11
12To add support for Mousekeys you simply need to add a single line to your keymap's `Makefile`: 12To add support for Mousekeys you simply need to add a single line to your keymap's `rules.mk`:
13 13
14``` 14```
15MOUSEKEY_ENABLE = yes 15MOUSEKEY_ENABLE = yes
16``` 16```
17 17
18You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/Makefile 18You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/keymaps/mouse_keys/rules.mk
19 19
20### Mapping Mouse Actions to Keyboard Keys 20### Mapping Mouse Actions to Keyboard Keys
21 21
diff --git a/docs/keycodes.md b/docs/keycodes.md
index fa02512de..030b23827 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -366,7 +366,7 @@ This is a reference only. Each group of keys links to the page documenting their
366|`KC_RIGHT_ANGLE_BRACKET`|`KC_GT`/`KC_RABK` |`>` | 366|`KC_RIGHT_ANGLE_BRACKET`|`KC_GT`/`KC_RABK` |`>` |
367|`KC_QUESTION` |`KC_QUES` |`?` | 367|`KC_QUESTION` |`KC_QUES` |`?` |
368 368
369## [Switching and Toggling Layers](feature_common_shortcuts.md#switching-and-toggling-layers) 369## [Switching and Toggling Layers](feature_advanced_keycodes.md#switching-and-toggling-layers)
370 370
371|Key |Description | 371|Key |Description |
372|---------------|----------------------------------------------------------------------------------| 372|---------------|----------------------------------------------------------------------------------|