just saving
This commit is contained in:
		
							parent
							
								
									21b6b4e6c4
								
							
						
					
					
						commit
						01736a502e
					
				
					 10 changed files with 54 additions and 232 deletions
				
			
		| 
						 | 
					@ -24,124 +24,49 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
				
			||||||
#define VENDOR_ID       0xFEED
 | 
					#define VENDOR_ID       0xFEED
 | 
				
			||||||
#define PRODUCT_ID      0x6060
 | 
					#define PRODUCT_ID      0x6060
 | 
				
			||||||
#define DEVICE_VER      0x0001
 | 
					#define DEVICE_VER      0x0001
 | 
				
			||||||
#define MANUFACTURER    Wootpatoot
 | 
					#define MANUFACTURER    wootpatoot
 | 
				
			||||||
#define PRODUCT         maxipad
 | 
					#define PRODUCT         maxipad
 | 
				
			||||||
#define DESCRIPTION     A custom keyboard
 | 
					#define DESCRIPTION     A custom keyboard
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					 | 
				
			||||||
/* key matrix size */
 | 
					/* key matrix size */
 | 
				
			||||||
#define MATRIX_ROWS 5
 | 
					#define MATRIX_ROWS 5
 | 
				
			||||||
#define MATRIX_COLS 6
 | 
					#define MATRIX_COLS 6
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/*
 | 
					// Planck PCB default pin-out
 | 
				
			||||||
 * Keyboard Matrix Assignments
 | 
					// Change this to how you wired your keyboard
 | 
				
			||||||
 *
 | 
					// COLS: Left to right, ROWS: Top to bottom
 | 
				
			||||||
 * Change this to how you wired your keyboard
 | 
					#ifdef USE_PRO_MICRO
 | 
				
			||||||
 * COLS: AVR pins used for columns, left to right
 | 
						#define MATRIX_ROW_PINS { B6, B2, B3, B1, F7 }
 | 
				
			||||||
 * ROWS: AVR pins used for rows, top to bottom
 | 
						#define MATRIX_COL_PINS { F4, C6, D7, F5, B4, B5 }
 | 
				
			||||||
 * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
 | 
						#define UNUSED_PINS
 | 
				
			||||||
 *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
 | 
					 #else
 | 
				
			||||||
 *
 | 
					 	#define MATRIX_ROW_PINS { B6, F7, B2, B3, B1 }
 | 
				
			||||||
*/
 | 
						#define MATRIX_COL_PINS { F6, C6, D7, F5, B4, B5 }
 | 
				
			||||||
#define MATRIX_ROW_PINS { B6, F7, B2, B3, B1 }
 | 
						#define UNUSED_PINS
 | 
				
			||||||
#define MATRIX_COL_PINS { F6, C6, D7, F5, B4, B5 }
 | 
					 #endif
 | 
				
			||||||
#define UNUSED_PINS
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
/* COL2ROW or ROW2COL */
 | 
					/* COL2ROW or ROW2COL */
 | 
				
			||||||
#define DIODE_DIRECTION COL2ROW
 | 
					#define DIODE_DIRECTION COL2ROW
 | 
				
			||||||
 | 
					
 | 
				
			||||||
// #define BACKLIGHT_PIN B7
 | 
					/* define if matrix has ghost */
 | 
				
			||||||
// #define BACKLIGHT_BREATHING
 | 
					 | 
				
			||||||
// #define BACKLIGHT_LEVELS 3
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
 | 
					 | 
				
			||||||
#define DEBOUNCING_DELAY 5
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
/* define if matrix has ghost (lacks anti-ghosting diodes) */
 | 
					 | 
				
			||||||
//#define MATRIX_HAS_GHOST
 | 
					//#define MATRIX_HAS_GHOST
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/* number of backlight levels */
 | 
					/* number of backlight levels */
 | 
				
			||||||
 | 
					#define BACKLIGHT_LEVELS 3
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/* Set 0 if debouncing isn't needed */
 | 
				
			||||||
 | 
					#define DEBOUNCING_DELAY 5
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
 | 
					/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
 | 
				
			||||||
#define LOCKING_SUPPORT_ENABLE
 | 
					#define LOCKING_SUPPORT_ENABLE
 | 
				
			||||||
/* Locking resynchronize hack */
 | 
					/* Locking resynchronize hack */
 | 
				
			||||||
#define LOCKING_RESYNC_ENABLE
 | 
					#define LOCKING_RESYNC_ENABLE
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/*
 | 
					/* key combination for command */
 | 
				
			||||||
 * Force NKRO
 | 
					 | 
				
			||||||
 *
 | 
					 | 
				
			||||||
 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
 | 
					 | 
				
			||||||
 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
 | 
					 | 
				
			||||||
 * makefile for this to work.)
 | 
					 | 
				
			||||||
 *
 | 
					 | 
				
			||||||
 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
 | 
					 | 
				
			||||||
 * until the next keyboard reset.
 | 
					 | 
				
			||||||
 *
 | 
					 | 
				
			||||||
 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
 | 
					 | 
				
			||||||
 * fully operational during normal computer usage.
 | 
					 | 
				
			||||||
 *
 | 
					 | 
				
			||||||
 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
 | 
					 | 
				
			||||||
 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
 | 
					 | 
				
			||||||
 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
 | 
					 | 
				
			||||||
 * power-up.
 | 
					 | 
				
			||||||
 *
 | 
					 | 
				
			||||||
 */
 | 
					 | 
				
			||||||
//#define FORCE_NKRO
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
/*
 | 
					 | 
				
			||||||
 * Magic Key Options
 | 
					 | 
				
			||||||
 *
 | 
					 | 
				
			||||||
 * Magic keys are hotkey commands that allow control over firmware functions of
 | 
					 | 
				
			||||||
 * the keyboard. They are best used in combination with the HID Listen program,
 | 
					 | 
				
			||||||
 * found here: https://www.pjrc.com/teensy/hid_listen.html
 | 
					 | 
				
			||||||
 *
 | 
					 | 
				
			||||||
 * The options below allow the magic key functionality to be changed. This is
 | 
					 | 
				
			||||||
 * useful if your keyboard/keypad is missing keys and you want magic key support.
 | 
					 | 
				
			||||||
 *
 | 
					 | 
				
			||||||
 */
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
/* key combination for magic key command */
 | 
					 | 
				
			||||||
#define IS_COMMAND() ( \
 | 
					#define IS_COMMAND() ( \
 | 
				
			||||||
    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
 | 
					    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
 | 
				
			||||||
)
 | 
					)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/* control how magic key switches layers */
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
/* override magic key keymap */
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_HELP1          H
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_HELP2          SLASH
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_DEBUG          D
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_DEBUG_MATRIX   X
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_DEBUG_KBD      K
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_DEBUG_MOUSE    M
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_VERSION        V
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_STATUS         S
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_CONSOLE        C
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER0_ALT1    ESC
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER0_ALT2    GRAVE
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER0         0
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER1         1
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER2         2
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER3         3
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER4         4
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER5         5
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER6         6
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER7         7
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER8         8
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LAYER9         9
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_BOOTLOADER     PAUSE
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_LOCK           CAPS
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_EEPROM         E
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_NKRO           N
 | 
					 | 
				
			||||||
//#define MAGIC_KEY_SLEEP_LED      Z
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
/*
 | 
					/*
 | 
				
			||||||
 * Feature disable options
 | 
					 * Feature disable options
 | 
				
			||||||
 *  These options are also useful to firmware size reduction.
 | 
					 *  These options are also useful to firmware size reduction.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,21 +0,0 @@
 | 
				
			||||||
# Build Options
 | 
					 | 
				
			||||||
#   change to "no" to disable the options, or define them in the Makefile in 
 | 
					 | 
				
			||||||
#   the appropriate keymap folder that will get included automatically
 | 
					 | 
				
			||||||
#
 | 
					 | 
				
			||||||
BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
 | 
					 | 
				
			||||||
MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
 | 
					 | 
				
			||||||
EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
 | 
					 | 
				
			||||||
CONSOLE_ENABLE = no         # Console for debug(+400)
 | 
					 | 
				
			||||||
COMMAND_ENABLE = yes        # Commands for debug and configuration
 | 
					 | 
				
			||||||
NKRO_ENABLE = yes           # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 | 
					 | 
				
			||||||
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
 | 
					 | 
				
			||||||
MIDI_ENABLE = no            # MIDI controls
 | 
					 | 
				
			||||||
AUDIO_ENABLE = no           # Audio output on port C6
 | 
					 | 
				
			||||||
UNICODE_ENABLE = no         # Unicode
 | 
					 | 
				
			||||||
BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 | 
					 | 
				
			||||||
RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
 | 
					 | 
				
			||||||
SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
ifndef QUANTUM_DIR
 | 
					 | 
				
			||||||
	include ../../../../Makefile
 | 
					 | 
				
			||||||
endif
 | 
					 | 
				
			||||||
| 
						 | 
					@ -1,8 +0,0 @@
 | 
				
			||||||
#ifndef CONFIG_USER_H
 | 
					 | 
				
			||||||
#define CONFIG_USER_H
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
#include "../../config.h"
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
// place overrides here
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
#endif
 | 
					 | 
				
			||||||
| 
						 | 
					@ -13,42 +13,14 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 | 
				
			||||||
  KC_TRNS, KC_TRNS, KC_UP, KC_TRNS, KC_TRNS, KC_TRNS, \
 | 
					  KC_TRNS, KC_TRNS, KC_UP, KC_TRNS, KC_TRNS, KC_TRNS, \
 | 
				
			||||||
  KC_TRNS, KC_LEFT, KC_DOWN, KC_RIGHT, KC_TRNS, KC_TRNS, \
 | 
					  KC_TRNS, KC_LEFT, KC_DOWN, KC_RIGHT, KC_TRNS, KC_TRNS, \
 | 
				
			||||||
  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, \
 | 
					  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, \
 | 
				
			||||||
  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS \
 | 
					  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  KC_SPC   \
 | 
				
			||||||
),
 | 
					),
 | 
				
			||||||
};
 | 
					};
 | 
				
			||||||
 
 | 
					 
 | 
				
			||||||
const uint16_t PROGMEM fn_actions[] = {
 | 
					const uint16_t PROGMEM fn_actions[] = {
 | 
				
			||||||
 | 
					 | 
				
			||||||
};
 | 
					};
 | 
				
			||||||
 
 | 
					 
 | 
				
			||||||
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 | 
					const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) // MACRODOWN only works in this function
 | 
				
			||||||
{
 | 
					{
 | 
				
			||||||
  // MACRODOWN only works in this function
 | 
					 | 
				
			||||||
      switch(id) {
 | 
					 | 
				
			||||||
        case 0:
 | 
					 | 
				
			||||||
          if (record->event.pressed) {
 | 
					 | 
				
			||||||
            register_code(KC_RSFT);
 | 
					 | 
				
			||||||
          } else {
 | 
					 | 
				
			||||||
            unregister_code(KC_RSFT);
 | 
					 | 
				
			||||||
          }
 | 
					 | 
				
			||||||
        break;
 | 
					 | 
				
			||||||
      }
 | 
					 | 
				
			||||||
    return MACRO_NONE;
 | 
					    return MACRO_NONE;
 | 
				
			||||||
};
 | 
					};
 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
void matrix_init_user(void) {
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
void matrix_scan_user(void) {
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 | 
					 | 
				
			||||||
  return true;
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
void led_set_user(uint8_t usb_led) {
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
| 
						 | 
					@ -1 +0,0 @@
 | 
				
			||||||
# The default keymap for maxipad
 | 
					 | 
				
			||||||
| 
						 | 
					@ -1,28 +1 @@
 | 
				
			||||||
#include "maxipad.h"
 | 
					#include "maxipad.h"
 | 
				
			||||||
 | 
					 | 
				
			||||||
void matrix_init_kb(void) {
 | 
					 | 
				
			||||||
	// put your keyboard start-up code here
 | 
					 | 
				
			||||||
	// runs once when the firmware starts up
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
	matrix_init_user();
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
void matrix_scan_kb(void) {
 | 
					 | 
				
			||||||
	// put your looping keyboard code here
 | 
					 | 
				
			||||||
	// runs every cycle (a lot)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
	matrix_scan_user();
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
 | 
					 | 
				
			||||||
	// put your per-action keyboard code here
 | 
					 | 
				
			||||||
	// runs for every action, just before processing by the firmware
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
	return process_record_user(keycode, record);
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
void led_set_kb(uint8_t usb_led) {
 | 
					 | 
				
			||||||
	// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
	led_set_user(usb_led);
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -8,18 +8,18 @@
 | 
				
			||||||
// The first section contains all of the arguements
 | 
					// The first section contains all of the arguements
 | 
				
			||||||
// The second converts the arguments into a two-dimensional array
 | 
					// The second converts the arguments into a two-dimensional array
 | 
				
			||||||
#define KEYMAP( \
 | 
					#define KEYMAP( \
 | 
				
			||||||
     k00, k01, k02, k03, k04, k05, \
 | 
					    k00, k01, k02, k03, k04, k05, \
 | 
				
			||||||
     k10, k11, k12, k13, k14, k15, \
 | 
					    k10, k11, k12, k13, k14, k15, \
 | 
				
			||||||
     k20, k21, k22, k23, k24, k25, \
 | 
					    k20, k21, k22, k23, k24, k25, \
 | 
				
			||||||
     k30, k31, k32, k33, k34, k35, \
 | 
					    k30, k31, k32, k33, k34, k35, \
 | 
				
			||||||
     k40, k41, k42, k43, k44, k45 \
 | 
					    k40, k41, k42, k43, k44, k45 \
 | 
				
			||||||
) \
 | 
					) \
 | 
				
			||||||
{ \
 | 
					{ \
 | 
				
			||||||
    { k00, k01, k02, k03, k04, k05 }, \
 | 
					    { k00, k01, k02, k03, k04, k05 }, \
 | 
				
			||||||
    { k10, k11, k12, k13, k14, k15 }, \
 | 
					    { k10, k11, k12, k13, k14, k15 }, \
 | 
				
			||||||
    { k20, k21, k22, k23, k24, k25 }, \
 | 
					    { k20, k21, k22, k23, k24, k25 }, \
 | 
				
			||||||
    { k30, k31, k32, k33, k34, k35 }, \
 | 
					    { k30, k31, k32, k33, k34, k35 }, \
 | 
				
			||||||
    { k40, k41, k42, k43, k44, k45} \
 | 
					    { k40, k41, k42, k43, k44, k45 } \
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#endif
 | 
					#endif
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,46 +1,27 @@
 | 
				
			||||||
maxipad keyboard firmware
 | 
					Maxipad keyboard firmware
 | 
				
			||||||
======================
 | 
					======================
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Quantum MK Firmware
 | 
					## Quantum MK Firmware
 | 
				
			||||||
 | 
					
 | 
				
			||||||
<<<<<<< HEAD
 | 
					For the full Quantum feature list, see [the parent readme.md](/readme.md).
 | 
				
			||||||
For the full Quantum feature list, see [the parent readme](/).
 | 
					 | 
				
			||||||
=======
 | 
					 | 
				
			||||||
For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
 | 
					 | 
				
			||||||
>>>>>>> bce6e52391da7c5f620c96a91857940f0dee19df
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Building
 | 
					## Building
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					If you are using a pro micro then make sure to enable USE_PRO_MICRO in the makefile
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Download or clone the whole firmware and navigate to the keyboards/maxipad folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. 
 | 
					Download or clone the whole firmware and navigate to the keyboards/maxipad folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Depending on which keymap you would like to use, you will have to compile slightly differently.
 | 
					Depending on which keymap you would like to use, you will have to compile slightly differently.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Default
 | 
					### Default
 | 
				
			||||||
 | 
					 | 
				
			||||||
<<<<<<< HEAD
 | 
					 | 
				
			||||||
To build with the default keymap, simply run `make default`.
 | 
					To build with the default keymap, simply run `make default`.
 | 
				
			||||||
=======
 | 
					 | 
				
			||||||
To build with the default keymap, simply run `make`.
 | 
					 | 
				
			||||||
>>>>>>> bce6e52391da7c5f620c96a91857940f0dee19df
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Other Keymaps
 | 
					### 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 file named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
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 folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
<<<<<<< HEAD
 | 
					 | 
				
			||||||
To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
 | 
					To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
$ make [default|jack|<name>]
 | 
					$ make [default|jack|<name>]
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					 | 
				
			||||||
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
 | 
					Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
 | 
				
			||||||
=======
 | 
					 | 
				
			||||||
To build the firmware binary hex file with a keymap just do `make` with `keymap` option like:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
```
 | 
					 | 
				
			||||||
$ make keymap=[default|jack|<name>]
 | 
					 | 
				
			||||||
```
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`
 | 
					 | 
				
			||||||
>>>>>>> bce6e52391da7c5f620c96a91857940f0dee19df
 | 
					 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,3 +1,5 @@
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# MCU name
 | 
					# MCU name
 | 
				
			||||||
#MCU = at90usb1287
 | 
					#MCU = at90usb1287
 | 
				
			||||||
MCU = atmega32u4
 | 
					MCU = atmega32u4
 | 
				
			||||||
| 
						 | 
					@ -49,19 +51,18 @@ OPT_DEFS += -DBOOTLOADER_SIZE=512
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Build Options
 | 
					# Build Options
 | 
				
			||||||
#   change yes to no to disable
 | 
					#   comment out to disable the options.
 | 
				
			||||||
#
 | 
					#
 | 
				
			||||||
BOOTMAGIC_ENABLE ?= no      # Virtual DIP switch configuration(+1000)
 | 
					BOOTMAGIC_ENABLE ?= yes	# Virtual DIP switch configuration(+1000)
 | 
				
			||||||
MOUSEKEY_ENABLE ?= yes       # Mouse keys(+4700)
 | 
					MOUSEKEY_ENABLE ?= yes	# Mouse keys(+4700)
 | 
				
			||||||
EXTRAKEY_ENABLE ?= yes       # Audio control and System control(+450)
 | 
					EXTRAKEY_ENABLE ?= yes	# Audio control and System control(+450)
 | 
				
			||||||
CONSOLE_ENABLE ?= yes        # Console for debug(+400)
 | 
					CONSOLE_ENABLE ?= yes	# Console for debug(+400)
 | 
				
			||||||
COMMAND_ENABLE ?= yes        # Commands for debug and configuration
 | 
					COMMAND_ENABLE ?= yes    # Commands for debug and configuration
 | 
				
			||||||
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
 | 
					# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
 | 
				
			||||||
SLEEP_LED_ENABLE ?= no       # Breathing sleep LED during USB suspend
 | 
					# SLEEP_LED_ENABLE ?= yes  # Breathing sleep LED during USB suspend
 | 
				
			||||||
# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 | 
					# NKRO_ENABLE ?= yes		# USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 | 
				
			||||||
NKRO_ENABLE ?= no            # USB Nkey Rollover
 | 
					# BACKLIGHT_ENABLE ?= yes  # Enable keyboard backlight functionality
 | 
				
			||||||
BACKLIGHT_ENABLE ?= no       # Enable keyboard backlight functionality on B7 by default
 | 
					# MIDI_ENABLE ?= YES 		# MIDI controls
 | 
				
			||||||
MIDI_ENABLE ?= no            # MIDI controls
 | 
					# UNICODE_ENABLE ?= YES 		# Unicode
 | 
				
			||||||
UNICODE_ENABLE ?= no         # Unicode
 | 
					# BLUETOOTH_ENABLE ?= yes # Enable Bluetooth with the Adafruit EZ-Key HID
 | 
				
			||||||
BLUETOOTH_ENABLE ?= no       # Enable Bluetooth with the Adafruit EZ-Key HID
 | 
					USE_PRO_MICRO ?= yes
 | 
				
			||||||
AUDIO_ENABLE ?= no           # Audio output on port C6
 | 
					 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue