opensteno_qmk/keyboards/maxipad/readme.md

<<<<<<< HEAD
Maxipad keyboard firmware
======================

## Quantum MK Firmware

For the full Quantum feature list, see [the parent readme.md](/readme.md).

If you are using a pro micro then make sure to enable USE_PRO_MICRO in the makefile
Change the config.h pinout to match your mcu!!

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.

### Default

To build with the default keymap, simply run `make`.


### 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.


To build the firmware binary hex file with a keymap just do `make` with a keymap like this:

```
$ make [default|jack|<name>]
```

Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware 2016-12-03 22:01:26 +00:00			`<<<<<<< HEAD`
just saving 2016-11-19 04:40:34 +00:00			`Maxipad keyboard firmware`
Updated my repo to current qmk 2016-11-17 00:18:54 +00:00			`======================`

			`## Quantum MK Firmware`

just saving 2016-11-19 04:40:34 +00:00			`For the full Quantum feature list, see [the parent readme.md](/readme.md).`
Updated my repo to current qmk 2016-11-17 00:18:54 +00:00
just saving 2016-11-19 04:40:34 +00:00			`If you are using a pro micro then make sure to enable USE_PRO_MICRO in the makefile`
changed readme 2016-11-19 05:49:20 +00:00			`Change the config.h pinout to match your mcu!!`
just saving 2016-11-19 04:40:34 +00:00
Updated my repo to current qmk 2016-11-17 00:18:54 +00:00			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.`

			`### Default`

Changes to be committed: new file: keyboards/lets_splitv2/Makefile new file: keyboards/lets_splitv2/config.h new file: keyboards/lets_splitv2/i2c.c new file: keyboards/lets_splitv2/i2c.h new file: keyboards/lets_splitv2/imgs/split-keyboard-i2c-schematic.png new file: keyboards/lets_splitv2/imgs/split-keyboard-serial-schematic.png new file: keyboards/lets_splitv2/keymaps/default/keymap.c new file: keyboards/lets_splitv2/lets_split.c new file: keyboards/lets_splitv2/lets_split.h new file: keyboards/lets_splitv2/matrix.c new file: keyboards/lets_splitv2/pro_micro.h new file: keyboards/lets_splitv2/readme.md new file: keyboards/lets_splitv2/serial.c new file: keyboards/lets_splitv2/serial.h new file: keyboards/lets_splitv2/split_util.c new file: keyboards/lets_splitv2/split_util.h new file: keyboards/maxipad/Makefile new file: keyboards/maxipad/config.h new file: keyboards/maxipad/keymaps/default/Makefile new file: keyboards/maxipad/keymaps/default/config.h new file: keyboards/maxipad/keymaps/default/keymap.c new file: keyboards/maxipad/keymaps/default/readme.md new file: keyboards/maxipad/maxipad.c new file: keyboards/maxipad/maxipad.h new file: keyboards/maxipad/readme.md 2016-11-10 23:19:13 +00:00			To build with the default keymap, simply run `make`.
fixed readme conflicts 2016-11-17 01:44:49 +00:00
Updated my repo to current qmk 2016-11-17 00:18:54 +00:00
			`### Other Keymaps`
just saving 2016-11-19 04:40:34 +00:00			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.
Updated my repo to current qmk 2016-11-17 00:18:54 +00:00

			To build the firmware binary hex file with a keymap just do `make` with a keymap like this:

			```
			`$ make [default\|jack\|<name>]`
			```

			Keymaps follow the format __\<name\>.c__ and are stored in the `keymaps` folder.