You can not select more than 25 topics
			Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
		
		
		
		
		
			
		
			
				
					26 lines
				
				1.2 KiB
			
		
		
			
		
	
	
					26 lines
				
				1.2 KiB
			| 
								 
											10 years ago
										 
									 | 
							
								Preonic keyboard firmware
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								======================
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								DIY/Assembled compact ortholinear 50% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								## Quantum MK Firmware
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								For the full Quantum feature list, see [the parent readme.md](/readme.md).
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								## Building
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								Download or clone the whole firmware and navigate to the keyboards/preonic folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button. 
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								
							 | 
						||
| 
								 | 
							
								Depending on which keymap you would like to use, you will have to compile slightly differently.
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								### Default
							 | 
						||
| 
								 | 
							
								To build with the default keymap, simply run `make`.
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								### Other Keymaps
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								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.
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								```
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								$ make KEYMAP=[default|jack|<name>]
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								```
							 | 
						||
| 
								 
											10 years ago
										 
									 | 
							
								Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
							 |