mirror of
				https://github.com/mfulz/qmk_firmware.git
				synced 2025-11-04 07:12:33 +01:00 
			
		
		
		
	Fixed typo of 'confid.h' to 'config.h' (#2448)
* Fixed typo of 'confid.h' to 'config.h' * Fixed broken links in docs
This commit is contained in:
		
							parent
							
								
									524053e3c0
								
							
						
					
					
						commit
						8e99fbc884
					
				@ -1,6 +1,6 @@
 | 
				
			|||||||
# Setting up Eclipse for QMK Development
 | 
					# Setting up Eclipse for QMK Development
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[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.
 | 
					[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.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Using an IDE such as Eclipse provides many advantages over a plain text editor, such as:
 | 
					Using an IDE such as Eclipse provides many advantages over a plain text editor, such as:
 | 
				
			||||||
* intelligent code completion
 | 
					* intelligent code completion
 | 
				
			||||||
@ -17,7 +17,7 @@ Note that this set-up has been tested on Ubuntu 16.04 only for the moment.
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
# Prerequisites
 | 
					# Prerequisites
 | 
				
			||||||
## Build Environment
 | 
					## Build Environment
 | 
				
			||||||
Before 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).
 | 
					Before 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).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Java
 | 
					## Java
 | 
				
			||||||
Eclipse 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.
 | 
					Eclipse 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
 | 
				
			|||||||
7. (Optional) Toggle the <kbd>Hide Empty Folders</kbd> icon button above the targets tree to only show your build target.
 | 
					7. (Optional) Toggle the <kbd>Hide Empty Folders</kbd> icon button above the targets tree to only show your build target.
 | 
				
			||||||
8. Double-click the build target you created to trigger a build.
 | 
					8. Double-click the build target you created to trigger a build.
 | 
				
			||||||
9. Select the <kbd>Console</kbd> view at the bottom to view the running build.
 | 
					9. Select the <kbd>Console</kbd> view at the bottom to view the running build.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					  [1]: https://en.wikipedia.org/wiki/Eclipse_(software)
 | 
				
			||||||
@ -82,7 +82,7 @@ The pitch standard (`PITCH_STANDARD_A`) is 440.0f by default - to change this, a
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
    #define PITCH_STANDARD_A 432.0f
 | 
					    #define PITCH_STANDARD_A 432.0f
 | 
				
			||||||
 | 
					
 | 
				
			||||||
You 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`:
 | 
					You 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`:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    #define NO_MUSIC_MODE
 | 
					    #define NO_MUSIC_MODE
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -5,17 +5,17 @@ Mousekeys is a feature that allows you to emulate a mouse using your keyboard. Y
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Adding Mousekeys to a Keymap
 | 
					## Adding Mousekeys to a Keymap
 | 
				
			||||||
 | 
					
 | 
				
			||||||
There 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.
 | 
					There 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.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Adding Mousekeys Support in the `Makefile`
 | 
					### Adding Mousekeys Support in the `rules.mk`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
To add support for Mousekeys you simply need to add a single line to your keymap's `Makefile`:
 | 
					To add support for Mousekeys you simply need to add a single line to your keymap's `rules.mk`:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
MOUSEKEY_ENABLE = yes
 | 
					MOUSEKEY_ENABLE = yes
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/Makefile
 | 
					You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/keymaps/mouse_keys/rules.mk
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Mapping Mouse Actions to Keyboard Keys
 | 
					### Mapping Mouse Actions to Keyboard Keys
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -366,7 +366,7 @@ This is a reference only. Each group of keys links to the page documenting their
 | 
				
			|||||||
|`KC_RIGHT_ANGLE_BRACKET`|`KC_GT`/`KC_RABK` |`>`                |
 | 
					|`KC_RIGHT_ANGLE_BRACKET`|`KC_GT`/`KC_RABK` |`>`                |
 | 
				
			||||||
|`KC_QUESTION`           |`KC_QUES`         |`?`                |
 | 
					|`KC_QUESTION`           |`KC_QUES`         |`?`                |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## [Switching and Toggling Layers](feature_common_shortcuts.md#switching-and-toggling-layers)
 | 
					## [Switching and Toggling Layers](feature_advanced_keycodes.md#switching-and-toggling-layers)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
|Key            |Description                                                                       |
 | 
					|Key            |Description                                                                       |
 | 
				
			||||||
|---------------|----------------------------------------------------------------------------------|
 | 
					|---------------|----------------------------------------------------------------------------------|
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user