forked from qmk/qmk_firmware
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
169ede0
commit 1a4a66f
Showing
3 changed files
with
30 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,16 @@ | ||
| Atomic keyboard firmware | ||
| ====================== | ||
| DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). | ||
| Atomic | ||
| === | ||
|
|
||
| ## Quantum MK Firmware | ||
|  | ||
|
|
||
| For the full Quantum feature list, see [the parent readme.md](/readme.md). | ||
| A compact 60% (15x5) ortholinear keyboard kit made and sold by OLKB. [More info on qmk.fm](http://qmk.fm/atomic/) | ||
|
|
||
| ## Building | ||
| Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert) | ||
| Hardware Supported: Atomic PCB rev1, Teensy 2.0 | ||
| Hardware Availability: no longer available | ||
|
|
||
| Download or clone the whole firmware and navigate to the keyboards/atomic 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. | ||
| Make example for this keyboard (after setting up your build environment): | ||
|
|
||
| Depending on which keymap you would like to use, you will have to compile slightly differently. | ||
| make atomic-default | ||
|
|
||
| ### Default | ||
| To build with the default keymap, simply run `make default`. | ||
|
|
||
| ### 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 a file in the keymaps folder 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. | ||
| See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,16 @@ | ||
| Planck keyboard firmware | ||
| ====================== | ||
| DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). | ||
| Planck | ||
| === | ||
|
|
||
| ## Quantum MK Firmware | ||
|  | ||
|
|
||
| For the full Quantum feature list, see [the parent readme.md](/readme.md). | ||
| A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/planck/) | ||
|
|
||
| ## Building | ||
| Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert) | ||
| Hardware Supported: Planck PCB rev1, rev2, rev3, rev4, Teensy 2.0 | ||
| Hardware Availability: [OLKB.com](https://olkb.com), [Massdrop](https://www.massdrop.com/buy/planck-mechanical-keyboard?mode=guest_open) | ||
|
|
||
| Download or clone the whole firmware and navigate to the keyboards/planck 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. | ||
| Make example for this keyboard (after setting up your build environment): | ||
|
|
||
| Depending on which keymap you would like to use, you will have to compile slightly differently. | ||
| make planck-rev4-default | ||
|
|
||
| ### Default | ||
| To build with the default keymap, simply run `make default`. | ||
|
|
||
| ### 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` in the keymaps folder, 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. | ||
|
|
||
| ### Notable forks (which some of the keymap files are from) | ||
| - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck) | ||
| - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c) | ||
| - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck) | ||
| - [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid) | ||
| See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,16 @@ | ||
| Preonic keyboard firmware | ||
| ====================== | ||
| DIY/Assembled compact ortholinear 50% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). | ||
| Preonic | ||
| === | ||
|
|
||
| ## Quantum MK Firmware | ||
|  | ||
|
|
||
| For the full Quantum feature list, see [the parent readme.md](/readme.md). | ||
| A compact 50% (12x5) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/preonic/) | ||
|
|
||
| ## Building | ||
| Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert) | ||
| Hardware Supported: Preonic PCB rev1, Teensy 2.0 | ||
| Hardware Availability: [OLKB.com](https://olkb.com/preonic/), [Massdrop](https://www.massdrop.com/buy/preonic-mechanical-keyboard?mode=guest_open) | ||
|
|
||
| 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. | ||
| Make example for this keyboard (after setting up your build environment): | ||
|
|
||
| Depending on which keymap you would like to use, you will have to compile slightly differently. | ||
| make preonic-default | ||
|
|
||
| ### Default | ||
| To build with the default keymap, simply run `make default`. | ||
|
|
||
| ### 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 a file in the keymaps folder 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. | ||
| See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. |